Difference between revisions of "Document Object"
m |
|||
| (3 intermediate revisions by the same user not shown) | |||
| Line 7: | Line 7: | ||
<tr><td>docid</td><td>[[int field]]</td><td>The ID number of this Document Object (unique within a single repository)</td></tr> | <tr><td>docid</td><td>[[int field]]</td><td>The ID number of this Document Object (unique within a single repository)</td></tr> | ||
<tr><td>rev_number</td><td>[[int field]]</td><td>The metadata revision number. Increased by 1 every time this record is modified.</td></tr> | <tr><td>rev_number</td><td>[[int field]]</td><td>The metadata revision number. Increased by 1 every time this record is modified.</td></tr> | ||
| − | <tr><td>files</td><td>multiple [[file field]]</td><td></td></tr> | + | <tr><td>files</td><td>multiple [[file field]]</td><td>[[File Object]]s associated with the Document Object</td></tr> |
| − | <tr><td>eprintid</td><td>eprint [[itemref field]]</td><td></td></tr> | + | <tr><td>eprintid</td><td>eprint [[itemref field]]</td><td>[[EPrint Object]] of the Document Object</td></tr> |
| − | <tr><td>pos</td><td>[[int field]]</td><td></td></tr> | + | <tr><td>pos</td><td>[[int field]]</td><td>Position of the Document Object within the EPrint Object (used in URLs)</td></tr> |
| − | <tr><td> | + | <tr><td>placement</td><td>[[int field]]</td><td>Placement of the Document Object within the EPrint Object (used in the workflow/citation ordering)</td></tr> |
| − | <tr><td> | + | <tr><td>mime_type</td><td>[[id field]]</td><td>MIME type of the primary file of the Document Object.</td></tr> |
| − | <tr><td> | + | <tr><td>format</td><td>[[namedset field]] document</td><td>Generalised format of the document.</td></tr> |
| − | <tr><td> | + | <tr><td>formatdesc</td><td>[[text field]]</td><td>Description of the format of the document .</td></tr> |
| − | <tr><td>security</td><td>[[namedset field]] security</td><td></td></tr> | + | <tr><td>language</td><td>[[namedset field]] languages</td><td>Language of the document.</td></tr> |
| − | <tr><td>license</td><td>[[namedset field]] licenses</td><td></td></tr> | + | <tr><td>security</td><td>[[namedset field]] security</td><td>Security for accessing the document.</td></tr> |
| − | <tr><td>main</td><td>[[set field]]</td><td></td></tr> | + | <tr><td>license</td><td>[[namedset field]] licenses</td><td>Licence for the document.</td></tr> |
| − | <tr><td>date_embargo</td><td>[[date field]]</td><td></td></tr> | + | <tr><td>main</td><td>[[set field]]</td><td>The filename of the document</td></tr> |
| + | <tr><td>date_embargo</td><td>[[date field]]</td><td>The date the document is emabargoed until.</td></tr> | ||
| + | <tr><td>date_embargo_retained</td><td>[[date field]]</td><td>Retained version of the embargo date for once it is lifted.</td></tr> | ||
| + | <tr><td>embargo_reason</td><td>[[namedset field]] embargo_reason</td><td>The reason the. document was embargoed</td></tr> | ||
| + | <tr><td>content</td><td>[[namedset]]</td><td>The version (e.g. draft, submitted, published, etc.) of the document.</td></tr> | ||
| + | </td></tr> | ||
</table> | </table> | ||
| + | |||
== Related configuration files == | == Related configuration files == | ||
| − | + | * [[doc_rewrite.pl]] | |
| − | * [[ | ||
| − | |||
* [[document_fields_automatic.pl]] | * [[document_fields_automatic.pl]] | ||
* [[document_fields_default.pl]] | * [[document_fields_default.pl]] | ||
* [[document_upload.pl]] | * [[document_upload.pl]] | ||
* [[document_validate.pl]] | * [[document_validate.pl]] | ||
| + | * [[media_info.pl]] | ||
| + | * [[security.pl]] | ||
| + | * [[Archives/ARCHIVEID/cfg/namedsets/]]content | ||
* [[Archives/ARCHIVEID/cfg/namedsets/]]document | * [[Archives/ARCHIVEID/cfg/namedsets/]]document | ||
| + | * [[Archives/ARCHIVEID/cfg/namedsets/]]embargo_reason | ||
* [[Archives/ARCHIVEID/cfg/namedsets/]]security | * [[Archives/ARCHIVEID/cfg/namedsets/]]security | ||
* [[Archives/ARCHIVEID/cfg/namedsets/]]licenses | * [[Archives/ARCHIVEID/cfg/namedsets/]]licenses | ||
| − | + | ||
| − | * [[ | + | == See Also == |
| + | * [[API:EPrints/DataObj/Document|EPrints::DataObj::Dcocument]] - API page | ||
Latest revision as of 16:00, 18 February 2022
EPrints 3 Reference: Directory Structure - Metadata Fields - Repository Configuration - XML Config Files - XML Export Format - EPrints data structure - Core API - Data Objects
Data Objects: Access - Document - EPrint - Event Queue - File - History - Import - Login Ticket - Request - Saved Search - Subject - User
Built in Fields
| Field Name | Type | Description |
|---|---|---|
| docid | int field | The ID number of this Document Object (unique within a single repository) |
| rev_number | int field | The metadata revision number. Increased by 1 every time this record is modified. |
| files | multiple file field | File Objects associated with the Document Object |
| eprintid | eprint itemref field | EPrint Object of the Document Object |
| pos | int field | Position of the Document Object within the EPrint Object (used in URLs) |
| placement | int field | Placement of the Document Object within the EPrint Object (used in the workflow/citation ordering) |
| mime_type | id field | MIME type of the primary file of the Document Object. |
| format | namedset field document | Generalised format of the document. |
| formatdesc | text field | Description of the format of the document . |
| language | namedset field languages | Language of the document. |
| security | namedset field security | Security for accessing the document. |
| license | namedset field licenses | Licence for the document. |
| main | set field | The filename of the document |
| date_embargo | date field | The date the document is emabargoed until. |
| date_embargo_retained | date field | Retained version of the embargo date for once it is lifted. |
| embargo_reason | namedset field embargo_reason | The reason the. document was embargoed |
| content | namedset | The version (e.g. draft, submitted, published, etc.) of the document. |
Related configuration files
- doc_rewrite.pl
- document_fields_automatic.pl
- document_fields_default.pl
- document_upload.pl
- document_validate.pl
- media_info.pl
- security.pl
- Archives/ARCHIVEID/cfg/namedsets/content
- Archives/ARCHIVEID/cfg/namedsets/document
- Archives/ARCHIVEID/cfg/namedsets/embargo_reason
- Archives/ARCHIVEID/cfg/namedsets/security
- Archives/ARCHIVEID/cfg/namedsets/licenses
See Also
- EPrints::DataObj::Dcocument - API page
