Hyper Open Edge Cloud

Guideline Documentation Document Anchor Uses Software And Publication Section Split By Hyphen

Documentation reference convention.
  • Last Update:2017-04-10
  • Version:001
  • Language:en

Documentation Document Anchor Uses Software And Publication Section Split By Hyphen

Anchor references are more restricted when creating documentation documents than when naming generic content. The anchor must be a lowercase software product (like "erp5" or "slapos") followed by a hyphen and a documentation publication section. Multi word publication sections are written as single Camelcase word

Good Examples:

erp5-HowTo
slapos-TechnicalNote
erp5-Tutorial

Bad Examples:

SlapOS-how-to-create-property-sheet
ERP5.HowTo.Create.Property.Sheet