This commit is contained in:
parent
afe3694a88
commit
8f289fbcb8
|
@ -19,7 +19,7 @@ This file is released into the public domain using [CC0].
|
||||||
|
|
||||||
## Files from other projects
|
## Files from other projects
|
||||||
|
|
||||||
Source code from the projects listed below are **not** part of vscode-texinfo.
|
Source code from the projects listed below are *not* part of vscode-texinfo.
|
||||||
However, when building the project, they are downloaded, compiled, and packaged
|
However, when building the project, they are downloaded, compiled, and packaged
|
||||||
into a single binary file alongside with vscode-texinfo.
|
into a single binary file alongside with vscode-texinfo.
|
||||||
|
|
||||||
|
|
15
README.md
15
README.md
|
@ -1,5 +1,5 @@
|
||||||
<!--
|
<!--
|
||||||
Copyright (C) 2020,2021 CismonX <admin@cismon.net>
|
Copyright (C) 2020,2021,2024 CismonX <admin@cismon.net>
|
||||||
|
|
||||||
Copying and distribution of this file, with or without modification, are
|
Copying and distribution of this file, with or without modification, are
|
||||||
permitted in any medium without royalty, provided the copyright notice and
|
permitted in any medium without royalty, provided the copyright notice and
|
||||||
|
@ -12,10 +12,9 @@
|
||||||
|
|
||||||
## About
|
## About
|
||||||
|
|
||||||
vscode-texinfo is an extension of Visual Studio Code which aims at improving
|
vscode-texinfo is an extension of [Visual Studio Code] which provides the
|
||||||
user experience for editing Texinfo documents.
|
following features for editing [Texinfo] documents:
|
||||||
|
|
||||||
Major features include:
|
|
||||||
* Syntax Highlighting
|
* Syntax Highlighting
|
||||||
* Code Completion
|
* Code Completion
|
||||||
* HTML Preview
|
* HTML Preview
|
||||||
|
@ -25,10 +24,12 @@ Major features include:
|
||||||
|
|
||||||
## Getting Started
|
## Getting Started
|
||||||
|
|
||||||
For instructions about how to install, use, and contribute to vscode-texinfo,
|
For instructions on how to install, use, and contribute to vscode-texinfo,
|
||||||
see the [online user manual].
|
see the [user manual].
|
||||||
|
|
||||||
<!-- Reference Links -->
|
<!-- Reference Links -->
|
||||||
|
|
||||||
|
[Visual Studio Code]: https://github.com/microsoft/vscode
|
||||||
|
[Texinfo]: https://www.gnu.org/software/texinfo/
|
||||||
[License]: https://img.shields.io/badge/license-GPL--3.0--or--later-blue.svg
|
[License]: https://img.shields.io/badge/license-GPL--3.0--or--later-blue.svg
|
||||||
[online user manual]: https://nongnu.org/vscode-texinfo/manual
|
[user manual]: https://nongnu.org/vscode-texinfo/manual
|
||||||
|
|
|
@ -9,6 +9,8 @@
|
||||||
@set vscode-docs-url https://code.visualstudio.com/docs
|
@set vscode-docs-url https://code.visualstudio.com/docs
|
||||||
@set vscode-api-url https://code.visualstudio.com/api
|
@set vscode-api-url https://code.visualstudio.com/api
|
||||||
@set gnu-texinfo-docs https://www.gnu.org/software/texinfo/manual/texinfo
|
@set gnu-texinfo-docs https://www.gnu.org/software/texinfo/manual/texinfo
|
||||||
|
@set sv-home-url https://sv.nongnu.org
|
||||||
|
@set sv-releases-url https://dl.sv.nongnu.org/releases
|
||||||
|
|
||||||
@tex
|
@tex
|
||||||
\global\def\linkcolor{0 0 1}
|
\global\def\linkcolor{0 0 1}
|
||||||
|
@ -20,7 +22,7 @@
|
||||||
This manual is for vscode-texinfo (version @value{VERSION}), an extension of
|
This manual is for vscode-texinfo (version @value{VERSION}), an extension of
|
||||||
Visual Studio Code.
|
Visual Studio Code.
|
||||||
|
|
||||||
Copyright @copyright{} 2021 CismonX <admin@@cismon.net>
|
Copyright @copyright{} 2021,2024 CismonX <admin@@cismon.net>
|
||||||
|
|
||||||
@quotation
|
@quotation
|
||||||
This manual is licensed under a
|
This manual is licensed under a
|
||||||
|
@ -51,7 +53,7 @@ Creative Commons Attribution-ShareAlike 4.0 International License}.
|
||||||
This manual is for vscode-texinfo (version @value{VERSION}), an extension of
|
This manual is for vscode-texinfo (version @value{VERSION}), an extension of
|
||||||
Visual Studio Code.
|
Visual Studio Code.
|
||||||
|
|
||||||
Copyright @copyright{} 2021 CismonX <admin@@cismon.net>
|
Copyright @copyright{} 2021,2024 CismonX <admin@@cismon.net>
|
||||||
|
|
||||||
This manual is licensed under a
|
This manual is licensed under a
|
||||||
@url{https://creativecommons.org/licenses/by-sa/4.0/,
|
@url{https://creativecommons.org/licenses/by-sa/4.0/,
|
||||||
|
@ -99,11 +101,11 @@ version 3 of the License}, or (at your option) any later version.
|
||||||
@node Contributing
|
@node Contributing
|
||||||
@section Contributing
|
@section Contributing
|
||||||
|
|
||||||
This project is hosted on @url{https://sv.gnu.org/p/vscode-texinfo, Savannah}.
|
This project is hosted on @url{@value{sv-home-url}/p/vscode-texinfo, Savannah}.
|
||||||
Any kind of contribution is welcome, including bug reports, patches, and
|
Any kind of contribution is welcome, including bug reports, patches, and
|
||||||
general discussions regarding the usage of vscode-texinfo.
|
general discussions regarding the usage of vscode-texinfo.
|
||||||
|
|
||||||
Before you submit something, please make sure that you have read this manual,
|
Before you post something, please make sure that you have read this manual,
|
||||||
and no one else has posted the same content.
|
and no one else has posted the same content.
|
||||||
|
|
||||||
|
|
||||||
|
@ -120,7 +122,7 @@ binary release, which is proprietary software. You can also build it from
|
||||||
|
|
||||||
@quotation Note
|
@quotation Note
|
||||||
Theoretically vscode-texinfo can work with any version of Visual Studio Code
|
Theoretically vscode-texinfo can work with any version of Visual Studio Code
|
||||||
since 1.40, but not all versions are tested. It's recommended to install a
|
since 1.82, but not all versions are tested. It's recommended to install a
|
||||||
latest release.
|
latest release.
|
||||||
@end quotation
|
@end quotation
|
||||||
|
|
||||||
|
@ -139,7 +141,7 @@ and you can find and install this extension (Extension ID:
|
||||||
@section Manual Installation
|
@section Manual Installation
|
||||||
|
|
||||||
You can manually download the @code{.vsix} file, from either Savannah's
|
You can manually download the @code{.vsix} file, from either Savannah's
|
||||||
@url{https://dl.sv.gnu.org/releases/vscode-texinfo/, download area},
|
@url{@value{sv-releases-url}/vscode-texinfo/, download area},
|
||||||
@url{https://open-vsx.org/extension/CismonX/texinfo, Open VSX Registry}, or the
|
@url{https://open-vsx.org/extension/CismonX/texinfo, Open VSX Registry}, or the
|
||||||
proprietary Visual Studio Marketplace.
|
proprietary Visual Studio Marketplace.
|
||||||
|
|
||||||
|
@ -148,28 +150,12 @@ you should check whether the file matches a trusted signature:
|
||||||
|
|
||||||
@set vsix-name texinfo-@value{VERSION}.vsix
|
@set vsix-name texinfo-@value{VERSION}.vsix
|
||||||
|
|
||||||
@ifhtml
|
|
||||||
@example
|
@example
|
||||||
wget -O cismonx.gpg.asc "https://sv.gnu.org/people/viewgpg.php?user_id=214244"
|
wget -O- '@value{sv-home-url}/people/viewgpg.php?user_id=214244' \
|
||||||
gpg --import cismonx.gpg.asc
|
| gpg --import
|
||||||
|
wget -O- @value{sv-releases-url}/vscode-texinfo/@value{vsix-name}.sig.asc \
|
||||||
wget https://dl.sv.gnu.org/releases/vscode-texinfo/@value{vsix-name}.sig.asc
|
| gpg --verify - @value{vsix-name}
|
||||||
gpg --verify @value{vsix-name}.sig.asc @value{vsix-name}
|
|
||||||
@end example
|
@end example
|
||||||
@end ifhtml
|
|
||||||
|
|
||||||
@ifnothtml
|
|
||||||
@example
|
|
||||||
wget -O cismonx.gpg.asc \
|
|
||||||
"https://sv.gnu.org/people/viewgpg.php?user_id=214244"
|
|
||||||
gpg --import cismonx.gpg.asc
|
|
||||||
|
|
||||||
wget "https://dl.sv.gnu.org/releases/vscode-texinfo/
|
|
||||||
@value{vsix-name}.sig.asc"
|
|
||||||
gpg --verify @value{vsix-name}.sig.asc @value{vsix-name}
|
|
||||||
@end example
|
|
||||||
@end ifnothtml
|
|
||||||
|
|
||||||
|
|
||||||
Finally, install the @code{.vsix} file to Visual Studio Code via command
|
Finally, install the @code{.vsix} file to Visual Studio Code via command
|
||||||
palette: @code{Extensions: Install from VSIX...}.
|
palette: @code{Extensions: Install from VSIX...}.
|
||||||
|
@ -178,7 +164,7 @@ palette: @code{Extensions: Install from VSIX...}.
|
||||||
@node Build from Source
|
@node Build from Source
|
||||||
@section Build from Source
|
@section Build from Source
|
||||||
|
|
||||||
You can generate the @code{.vsix} file from the source code of vscode-texinfo.
|
The @code{.vsix} file can be built from the source code of vscode-texinfo.
|
||||||
|
|
||||||
First, clone the source code repository:
|
First, clone the source code repository:
|
||||||
|
|
||||||
|
@ -370,7 +356,7 @@ the extension. To manually trigger a refresh, click the status bar item.
|
||||||
@section HTML Preview
|
@section HTML Preview
|
||||||
|
|
||||||
You can generate the HTML preview of a Texinfo document in Visual Studio Code,
|
You can generate the HTML preview of a Texinfo document in Visual Studio Code,
|
||||||
to see how the document looks like when displayed online.
|
to see how the document looks like when displayed in a web browser.
|
||||||
|
|
||||||
In the active text editor which contains a Texinfo document, click the ``Show
|
In the active text editor which contains a Texinfo document, click the ``Show
|
||||||
Preview'' button on the top right of the editor. A webview will be created in a
|
Preview'' button on the top right of the editor. A webview will be created in a
|
||||||
|
|
|
@ -163,7 +163,7 @@
|
||||||
"texinfo.makeinfo": {
|
"texinfo.makeinfo": {
|
||||||
"type": "string",
|
"type": "string",
|
||||||
"default": "makeinfo",
|
"default": "makeinfo",
|
||||||
"description": "Path to the makeinfo (or texi2any) command."
|
"description": "Path to the makeinfo (or texi2any) program."
|
||||||
},
|
},
|
||||||
"texinfo.preview.customCSS": {
|
"texinfo.preview.customCSS": {
|
||||||
"type": "string",
|
"type": "string",
|
||||||
|
|
Loading…
Reference in New Issue
Block a user