Help pages should follow a standard for headers and sub-topics. Formatted headers will automatically display under the "On this page" section on the right of each page.
App Navigation Menu
Upon logging in, the navigation menu is always displayed at the bottom of the screen. There are four main navigation icons in addition to the logout icon:
Inspections – Displays a list of evaluations assigned to current user and the ability to create new inspections.
User – Display the current user information.
Sync - Allows user to synchronize data with server.
+ – Add new inspection or Create New Site.
Bullet Points
Use bullet points when listing out steps.
Use of Macros
Code Block
Use the "Code Block" macro when including sample of code in the help documentation.
<<foreach [ permit in permits.OrderBy(e => e.permitNum)]>><</foreach>>
Tables
Use tables to organize lists and columns of data.
ID
Description
Notes
PRMT_ID
Permit ID
Use this tag on a form control when integrating with nCORE
SITE_NAME
Site Name
Use this tag on a form control when integrating with nCORE
Info Macro
Use the "Info" macro for important or additional pieces of information that should be called out in the help page.
