Typographic Conventions
The following conventions are used in the Ingeniux online documentation to distinguish elements of text:
Item | Convention | Example |
---|---|---|
CMS Versions | .x refers to entirety of major release. Note : Version numbering correlates to major.minor.patch
| Ingeniux CMS 10.x 10.5.94 |
Code samples | Monospace in examples (or displayed in a screen capture) Elements in bold Attributes in italic Values in italic |
add element indexingEnabled attribute Enter the value as true |
Command-line commands and options (switches) | All lowercase, bold | copy command /a option |
Commands on menus | Bold in procedures; regular font elsewhere | File menu |
Dialog box options | Bold in procedures; regular font elsewhere | Click OK. |
Dialog box titles | Bold in procedures; regular font elsewhere | Find and Replace dialog |
Error message names | Sentence-style capitalization | Access denied. |
File names | Title capitalization; internal capitalization (camel casing) may be used for readability Italic | Filename.doc FileName.doc |
File paths | Title capitalization; internal capitalization (camel casing) may be used for readability Italic Note Use backslash (\) for Windows; forward
slash (/) for Linux | [path-to-cms-site-instance]\App_Data\xmlCustom |
Folder and directory names | Bold in procedures; regular font elsewhere. Initial capitalization; internal capitalization can be used for readability | Open the NewDocs folder. \\Ingeniux\IngeniuxCMSSetup |
Icons | Icon titles bold in procedures; regular font elsewhere | Save icon checkmark icon |
Options in drop-down menu or drop-down list | Italic | Select blue from the drop-down list. |
Parameters | Italic | CFFagentname |
Programming elements (API names, methods, classes, directives, functions, and so on) | Bold in text; monospace in examples | ICMSPageFactory Interface |
URLs | Lowercase | http://support.ingeniux.com |