When developing a template, you need access to the language's technical documentation. The extension provides rapid access to technical help when using language elements.
Due to the technical limitations of the layout imposed by the Visual Studio Code editor, this help is a condensed version of the official help.
As a reminder, the official complete technical documentation is referenced below:
- APE Adelia documentation: Adelia Print Engine (APE),
- Apache FreeMarker language documentation: https://freemarker.apache.org/,
- XSL (XSL-FO) v1.1 language documentation: https://www.w3.org/TR/xsl/ as well as a French translation of this help in version 1.0 http://www.yoyodesign.org/doc/w3c/xsl1/Overview.html.
The extension provides help relating to the macros and functions of hardisAdv, hardisCore, hardisCSS and hardisFo libraries. Help relating to the settings of all the hardisFo macros is also available.
Contextual help relating to auto-complete
When IntelliSense is enabled, a descriptive text of the available choice (macro, function or parameter) is displayed.
Contextual help relating to hover
This help is enabled when hovering over a language element (library name, macro, function or parameter):
Help relating to the element the cursor is on can also be enabled using the command palette: Open the palette with the shortcut (in Windows) "Ctrl" + "Shift" + "P" then type the command "show hover" to select it then press "Enter" to enable it:
The contextual help content often refers to the official help via a hypertext link (in blue). When a request is made to open an external link, Visual Studio Code requests confirmation to open it. To avoid having to confirm each time, the link's URL source needs to be added as a trusted site:
Note: Trusted sites are managed in Visual Studio Code by enabling the "Manage Trusted Domains" command with the command palette (Ctrl + Shift + P in Windows). ↑ Top of page