Use the navigation to the left to find information about features you have questions, or the search at the top to look for key words within the text.
Help Pages is an addon collection that creates a mark-down based help system from help documents installed by addon collections. Help-Pages is the term used for this help system. It is composed from text documents or articles called Help-Files stored on the server in the HelpFiles folder of the privateFiles file storage area. The Help Pages display is composed of two sections, the navigation on the left and the article on the right. Help navigation on the left is categorized into topics.
These help documents are written in Markdown, a common open source notation used to format text documents. There are many resources available online for markdown, such as Markdown Cheat Sheet.
The help section only uses markdown files, designed by the ".md" file extension. Other files are ignored. The filename is used to create the left-side navigation entry, so a file named "This is my file.md" would create a navigation link on the left "This is my file" and when clicked, the markdown text in that file will display. If the filename includes a period (excluding the file extension) then the text to the left of the period becomes the navigation entry, and when clicked it opens to a subhead with the next to the right of the period. That subhub can then be clicked to read the text
To add an article to the Help Pages system, open the feature's GitHub repository and add/edit articles in the /helpfile folder.
The article's filename is used as the linked text on the left navigation under the category named for collection.
Articles are written using the Markdown formatting standard. For help with syntax, use on of the Markdown Cheatsheets
Help articles are installed using the feature's collection installation.
To designate an article's role restrictions, save it in the appropriate folder
Uses in higher level roles can automatically see articles written for lower level roles.
This is the installed default.md file. It is displayed in /help when no other page is selected. To replace this file, upload a new file named default.md. If you delete this page it will be replaced with this copy.