Difference between revisions of "EGI-InSPIRE:Document naming convention"
Jump to navigation
Jump to search
(7 intermediate revisions by 2 users not shown) | |||
Line 1: | Line 1: | ||
{{Template:EGI-Inspire menubar}} | |||
*'''Filenames''' | |||
Filenames must use the following format in order to link any item back to other versions placed in the document repository. The filename format is: | Filenames must use the following format in order to link any item back to other versions placed in the document repository. The filename format is: | ||
EGI-<DOCUMENT IDENTIFIER>-<REPOSITORY ID>-V<VERSION> | '''EGI-<DOCUMENT IDENTIFIER>-<REPOSITORY ID>-V<VERSION>''' | ||
{| border="1" | |||
|- | |||
| '''DOCUMENT IDENTIFIER''' || The document identifier is dependent on the document type. If the document is: | |||
* Deliverable: Use the deliverable name: e.g. D1.1, D5.5, etc. | * Deliverable: Use the deliverable name: e.g. D1.1, D5.5, etc. | ||
* Milestone: Use the milestone name: e.g. MS102, MS504, etc. | * Milestone: Use the milestone name: e.g. MS102, MS504, etc. | ||
* Activity: Use the activity code: e.g. SA1, NA3, etc. | * Activity: Use the activity code: e.g. SA1, NA3, etc. | ||
* Committee/Board: Use an acronym based on the committee or board name: e.g. TCB, OMB, UCB, USAG, SPG, etc. | * Committee/Board: Use an acronym based on the committee or board name: e.g. TCB, OMB, UCB, USAG, SPG, etc. | ||
* Other: If the source of the material cannot be identified then ignore this section. | * Other: If the source of the material cannot be identified then ignore this section.|| | ||
|- | |||
| '''REPOSITORY ID'''|| This is the identification number generated by the document repository.|| | |||
|- | |||
| '''VERSION'''|| This is the version number generated by the document repository for the particular repository identifier. | |||
|- | |||
|} | |||
*'''Document titles''' | |||
The title of documents uploaded to document repository must be in the following format: | |||
'''<DOCUMENT IDENTIFIER> Title''' (from the first page of the document) | |||
Example: [https://documents.egi.eu/public/ShowDocument?docid=60 MS301 User Support Contacts] |
Latest revision as of 13:13, 6 January 2015
EGI Inspire Main page |
- Filenames
Filenames must use the following format in order to link any item back to other versions placed in the document repository. The filename format is:
EGI-<DOCUMENT IDENTIFIER>-<REPOSITORY ID>-V<VERSION>
DOCUMENT IDENTIFIER | The document identifier is dependent on the document type. If the document is:
| |
REPOSITORY ID | This is the identification number generated by the document repository. | |
VERSION | This is the version number generated by the document repository for the particular repository identifier. |
- Document titles
The title of documents uploaded to document repository must be in the following format:
<DOCUMENT IDENTIFIER> Title (from the first page of the document)
Example: MS301 User Support Contacts