From df56d4a023177eeb7d3cc8ddedc3bef2ccbb7f02 Mon Sep 17 00:00:00 2001 From: CismonX Date: Sat, 10 Apr 2021 13:35:00 +0800 Subject: [PATCH] Update documentation. --- doc/vscode-texinfo.texi | 78 ++++++++++++++++++++++++++--------------- 1 file changed, 49 insertions(+), 29 deletions(-) diff --git a/doc/vscode-texinfo.texi b/doc/vscode-texinfo.texi index bc75292..fbd5bf7 100644 --- a/doc/vscode-texinfo.texi +++ b/doc/vscode-texinfo.texi @@ -75,13 +75,13 @@ We believe that Texinfo deserves more users, for it is an excellent format for writing software manuals, as well as other technical materials. We chose Visual Studio Code, one of the most popular code editors as of 2020, and developed this very extension, vscode-texinfo, which provides some useful features for Visual -Studio Code in regard to the Texinfo format, in the hope that more developers -can benefit from it. +Studio Code regarding the Texinfo format, in the hope that more developers can +benefit from it. vscode-texinfo is free software. You can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software -Foundation, either version 3 of the License, or (at your option) any later -version. +Foundation, either @url{https://www.gnu.org/licenses/gpl-3.0-standalone.html, +version 3 of the License}, or (at your option) any later version. @menu * Contributing:: Contribute to vscode-texinfo. @@ -91,10 +91,9 @@ version. @node Contributing @section Contributing -This project is hosted on @url{https://sv.gnu.org/p/vscode-texinfo, Savannah}, -where contribution takes place. Any kind of contribution is welcome, including -bug reports, patches, and general discussions regarding the usage of -vscode-texinfo. +This project is hosted on @url{https://sv.gnu.org/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, and no one else has posted the same content. @@ -117,16 +116,25 @@ Code since 1.40, but not all versions are tested. It's recommended to install a latest release. @end quotation -The easiest way to install vscode-texinfo is from the extension marketplace, -either @url{https://open-vsx.org/extension/CismonX/texinfo, Open VSX Registry}, -or the proprietary Visual Studio Marketplace. Click the ``Extensions'' tab on -Visual Studio Code's sidebar, type ``texinfo'' and you can find and install this -extension. +The easiest way to install vscode-texinfo is from the extension marketplace. +Click the ``Extensions'' tab on Visual Studio Code's sidebar, type ``texinfo'' +and you can find and install this extension. -You can also download the @code{.vsix} file, and manually install it to Visual -Studio Code (via command palette: @code{Extensions: Install from VSIX...}). +@menu +* Manual Installation:: Download and install vscode-texinfo manually +* Build from Source:: Build vscode-texinfo from source code. +@end menu -Before you manually install a @code{.vsix} file downloaded from a third party, + +@node Manual Installation +@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{https://open-vsx.org/extension/CismonX/texinfo, Open VSX Registry}, or the +proprietary Visual Studio Marketplace. + +Before you install a @code{.vsix} file downloaded from a third party, you should check whether the file matches a trusted signature: @example @@ -137,9 +145,8 @@ wget https://dl.sv.gnu.org/releases/vscode-texinfo/texinfo-0.2.0.vsix.sig.asc gpg --verify texinfo-0.2.0.vsix.sig.asc texinfo-0.2.0.vsix @end example -@menu -* Build from Source:: Build vscode-texinfo from source code. -@end menu +Finally, install the @code{.vsix} file to Visual Studio Code via command +palette: @code{Extensions: Install from VSIX...}. @node Build from Source @@ -295,13 +302,26 @@ which converts a Texinfo document to some other format, like HTML, PDF, plain text, etc. To specify the location of @code{makeinfo}, edit the configuration item -@code{texinfo.makeinfo}. If the executable is not located in @code{$PATH}, an -absolute path should be specified. Also note that the path should not contain -any command line arguments. +@code{texinfo.makeinfo}. If it's not located in @code{$PATH}, an absolute path +should be specified. Also note that the path should not contain any command line +arguments. -To check whether GNU Texinfo is correctly installed and configured, open a -Texinfo document, and look for a ``GNU Texinfo'' status bar item on the right -side of the status bar. +To check whether GNU Texinfo is correctly installed and configured, see +@ref{Version Indicator}. + +@menu +* Version Indicator:: Show the installed version of GNU Texinfo +* HTML Preview:: Display document preview in HTML format. +* Diagnosis:: Show diagnostic information. +@end menu + + +@node Version Indicator +@section Version Indicator + +The version indicator is as status bar item with text ``GNU Texinfo''. It is +located on the right side of the status bar, which is shown when the active text +editor contains a Texinfo document. If you see a @b{check icon} and the version of GNU Texinfo, then congratulations, you're all set. If a @b{cross icon} is displayed, it means @@ -311,10 +331,10 @@ If a @b{warning icon} is displayed, it means that the currently installed GNU Texinfo is outdated, or has an unrecognizable version number. In that case, some features may not work as expected. -@menu -* HTML Preview:: Display document preview in HTML format. -* Diagnosis:: Show diagnostic information. -@end menu +@quotation Note +The version indicator does not automatically refresh since the activation of the +extension. To manually trigger a refresh, click the status bar item. +@end quotation @node HTML Preview