Most Powerful Open Source ERP

Guideline Document Name Must Use Anchor, Reference, Name, Version, Language And File Type

Main rule for document names.
  • Last Update:2017-04-10
  • Version:001
  • Language:en

Document Name Must Use Anchor, Reference, Name, Version, Language And File Type

All documents must consist of the following parts (in the order listed):

  • Anchor and
  • Reference representing a project (ex. P-JIO), group or the publication section a document is related to.
  • Document Name (ex. Design.Document) which represents a document name or title.
  • Version number (ex. 001).
  • Language (ex. en).
  • File Extension in relation to the MIME type (ex. .odt).

The generic format for a reference is:

[Anchor-Reference].[Dotted.Document.Name]-[Version]-[Language].[Mimetype]

Good Example:

P-BAOBAB.Design.Document-001-en.odt
NXD-Operation.Rules-002-en.odt
erp5-Solution.Overview-001-de.html

Bad Example:

MyFile.html
How-To.Do.Something.html
Document123.js

This naming convention applies to documents stored as files. Documents stored in ERP5 DMS (document management system) do not require language, version and file extension in the reference, because these will be managed automatically by ERP5.

A document will be stored like this:

Reference:   P-BAOBAB.Design.Document
Version:     001
Language:    en
Portal Type: Text (read-only)

So when creating document name, leave away the aforementioned parts.

Good Example:

P-BAOBAB.Design.Document
NXD-Operation.Rules
erp5-Solution.Overview

Bad Example:

mySample-001-en.odt
NXD-Operation.Rules-002-en.odt