ExternalVendorCode/openmct
1
0
Fork 0
mirror of https://github.com/nasa/openmct.git synced 2024-12-22 06:27:48 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

[Documentation] Clarify identifier syntax

Browse Source 
...in plain English, for the humans.

Per code review in nasa/openmctweb#257
This commit is contained in:
Victor Woeltjen 2015-11-21 06:52:19 -08:00
parent e6c9cbf0cd
commit 9656e09066
1 changed files with 15 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

18
docs/src/guide/index.md
View File

@ -687,15 +687,27 @@ A domain object identifier has one or two parts, separated by a colon.
* If two parts are present, the part before the colon refers to the space * If two parts are present, the part before the colon refers to the space
in which the domain object resides. This may be a persistence space or in which the domain object resides. This may be a persistence space or
a purely symbolic space recognized by a specific model provider. a purely symbolic space recognized by a specific model provider. The
part after the colon is the key to use when looking up the domain object
model within that space.
* If only one part is present, the domain object has no space specified, * If only one part is present, the domain object has no space specified,
and may presume to reside in the application-configured default space and may presume to reside in the application-configured default space
defined by the `PERSISTENCE_SPACE` constant. defined by the `PERSISTENCE_SPACE` constant.
* Both the key and the space identifier may consist of any combination
of alphanumeric characters, underscores, dashes, and periods.
Some examples:
* A domain object with the identifier `foo:xyz` would have its model
loaded using key `xyz` from persistence space `foo`.
* A domain object with the identifier `bar` would have its model loaded
using key `bar` from the space identified by the `PERSISTENCE_SPACE`
constant.
```bnf ```bnf
<identifier> ::= <space> ":" <simple id> | <simple id> <identifier> ::= <space> ":" <key> | <key>
<space> ::= <id char>+ <space> ::= <id char>+
<simple id> ::= <id char>+ <key> ::= <id char>+
<id char> ::= <letter> | <digit> | "-" | "." | "_" <id char> ::= <letter> | <digit> | "-" | "." | "_"
``` ```