Typographic conventions for Neptune documentation

Apply the following conventions when creating documentation for Neptune:

Product names

  • Treat as proper noun.

  • Do not highlight in bold or italics.

  • Do not use an article before "Neptune DXP - Open Edition" or "DXP - Open Edition"

Examples

  • Neptune DXP

  • Neptune DXP - Open Edition or the short form DXP - Open Edition

  • Linux

  • Windows

  • Oracle

  • OSX

  • iOS

  • macOS

Neptune applications

  • Treat as proper noun.

  • Highlight in italics.

Examples

  • API Designer

  • App Designer

  • Store

Neptune application as part of a heading or link text

  • If a Neptune application is part of a heading or a link text, it is not written in italics but with capital letters.

Components or events

  • Capitalize the name of the component or event.

  • Do not capitalize the word components or event.

  • Highlight in bold.

Examples

  • Button component

  • Press event

GUI elements

  • Capitalize as in GUI.

  • Highlight in bold.

  • Do not capitalize every letter, even if a word is capitalized completely in the GUI. In that cases, only capitalize the first letter.

Example

Navigate to Cockpit > Security > Role and check ACL for new functions delivered in the new version.

Pane

  • Do not capitalize the name of the pane or write it in bold

  • Do not write in bold any terms that do not appear on the interface

Example

The component properties pane shows the attributes of a component.

Code and code snippets

Use the following syntax:

Code
Example
[Service] ExecStart=/var/planet9/planet9-linux
Restart=always
User=MyUser
Group=nobody
# NoticetheNPMpath
Environment=PATH=/home/MyUser/.nvm/versions/node/v10.16.3/bin:/usr/
bin:/usr/local/bin
Environment=NODE_ENV=production
WorkingDirectory=/var/planet9
[Install] WantedBy=multi-user.target

Inline code

Use the following syntax:

`inline code`
Example

Run npm rebuild in the directory.

Files

  • Capitalize file names as given or default small caps.

  • Highlight in italics

Examples

  • file.js

  • appdesigner.exe

Values, properties, attributes, examples

  • Should be written as code. See Inline code.