From 8f289fbcb858a6ed3b4fc3e96036d988f2970ed8 Mon Sep 17 00:00:00 2001 From: CismonX Date: Thu, 4 Apr 2024 08:13:38 +0800 Subject: [PATCH] chore: update docs --- LICENSE_NOTICE.md | 2 +- README.md | 15 ++++++++------- doc/vscode-texinfo.texi | 42 ++++++++++++++--------------------------- package.json | 2 +- 4 files changed, 24 insertions(+), 37 deletions(-) diff --git a/LICENSE_NOTICE.md b/LICENSE_NOTICE.md index cc5bd38..e1f072e 100644 --- a/LICENSE_NOTICE.md +++ b/LICENSE_NOTICE.md @@ -19,7 +19,7 @@ This file is released into the public domain using [CC0]. ## 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 into a single binary file alongside with vscode-texinfo. diff --git a/README.md b/README.md index bd6ab67..4c7a130 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,5 @@ +[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 -[online user manual]: https://nongnu.org/vscode-texinfo/manual +[user manual]: https://nongnu.org/vscode-texinfo/manual diff --git a/doc/vscode-texinfo.texi b/doc/vscode-texinfo.texi index d7042fe..f224005 100644 --- a/doc/vscode-texinfo.texi +++ b/doc/vscode-texinfo.texi @@ -9,6 +9,8 @@ @set vscode-docs-url https://code.visualstudio.com/docs @set vscode-api-url https://code.visualstudio.com/api @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 \global\def\linkcolor{0 0 1} @@ -20,7 +22,7 @@ This manual is for vscode-texinfo (version @value{VERSION}), an extension of Visual Studio Code. -Copyright @copyright{} 2021 CismonX +Copyright @copyright{} 2021,2024 CismonX @quotation 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 Visual Studio Code. -Copyright @copyright{} 2021 CismonX +Copyright @copyright{} 2021,2024 CismonX This manual is licensed under a @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 @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 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. @@ -120,7 +122,7 @@ binary release, which is proprietary software. You can also build it from @quotation Note 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. @end quotation @@ -139,7 +141,7 @@ and you can find and install this extension (Extension ID: @section Manual Installation 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 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 -@ifhtml @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} +wget -O- '@value{sv-home-url}/people/viewgpg.php?user_id=214244' \ + | gpg --import +wget -O- @value{sv-releases-url}/vscode-texinfo/@value{vsix-name}.sig.asc \ + | gpg --verify - @value{vsix-name} @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 palette: @code{Extensions: Install from VSIX...}. @@ -178,7 +164,7 @@ palette: @code{Extensions: Install from VSIX...}. @node 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: @@ -370,7 +356,7 @@ the extension. To manually trigger a refresh, click the status bar item. @section HTML Preview 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 Preview'' button on the top right of the editor. A webview will be created in a diff --git a/package.json b/package.json index 73be267..c81f731 100644 --- a/package.json +++ b/package.json @@ -163,7 +163,7 @@ "texinfo.makeinfo": { "type": "string", "default": "makeinfo", - "description": "Path to the makeinfo (or texi2any) command." + "description": "Path to the makeinfo (or texi2any) program." }, "texinfo.preview.customCSS": { "type": "string",