metadata.template

Package: WA2L/WinTools 1.2.08
Section: File Formats (4)
Updated: 22 July 2017
Index Return to Main Contents

 

NAME

metadata.template - meta data template file customization for metadata

 

SYNOPSIS

WA2LWinTools/lib/metadata.default.meta

WA2LWinTools/etc/metadata.suffix.meta

WA2LWinTools/etc/metadata.default.meta

 

AVAILABILITY

WA2L/WinTools

 

DESCRIPTION

This template file(s) are used to define the format of the meta data file path/filename.suffix.meta which is presented by the metadata command.

 

FILEFORMAT

You are free how to define the contents of the metadata template. However you should keep the format:

Field Name     : @FIELD NAME@

to allow further processing of the file. Number of spaces between the Field Name, the colon (:) and the field data place holder @NAME@ can be changed.

The [GENERAL] section title should not be removed to allow further processing of the file. The fields within the section can be changed.

You should not change the [IDENTIFICATION] section (except for the number of spaces between the fields and the separating colon) to allow the metadata command to properly identify the file in future releases of the WA2L/WinTools package.

The section order is not important, but the sections must start in the leftmost column. Additional sections can be defined as needed.


[GENERAL]

Ref                             : [@BIBTEX BIBTEXKEY@]
Type                            : Article
Category                        : @BIBTEX CATEGORY@

Title                           : @TITLE@
Subtitle                        : @SUBTITLE@
Publisher                       : @COMPANY@
Author                          : @AUTHOR@
Date                            : @DATE@
Version                         : @VERSION@
State                           : @STATE@

ID                              : @DOC-ID@
ISBN                            : @ISBN@
ISSN                            : @ISSN@
DOI                             : @DOI@
Number                          : @NUMBER@
Part Number                     : @PART NUMBER@

File                            : @_FILE@
Pages                           : @_PAGES@
Source                          : @SOURCE@

Keywords                        : @KEYWORDS@

Abstract                        : @SUBJECT@

[IDENTIFICATION]

Checksum                        : @_CHECKSUM@
Filename                        : @_FILENAME@
Metadata Timestamp              : @_TIMESTAMP@

[RAWMETADATA]

@_ALL@

You don't have to define all fields you can think about that could be useful in any situation in a template file, you can add a specific field also simply when you are entering the meta data for a certain document.

 

OPTIONS

@NAME@
meta field name as resolved from file. The NAME has to be specified in upper case always, also when the meta data field contains upper/lower case.

The available field names can be seen in the [RAWMETADATA] section when using the metadata command and using the built in default template from lib/metadata.default.meta.

@_GUID@
a GUID number.

@_PAGES@
number of pages from fields Pages, Page Count or Slides. Prefer this option over the Pages/Page Count/Slides fields to always get a page number independent of the FASTPDFRESOLUTION=... setting in the metadata.cfg file and the file type.

@_FILENAME@
file name including path.

@_FILE@
file name without path.

@_DIRECTORY@
directory (path) of the file name.

@_SUFFIX@
suffix of the file.

@_CHECKSUM@
file checksum.

@_TIMESTAMP@
time stamp of meta data file creation.

@_ALL@
all resolved meta data of file specified as metadata command option. The meta data contained in a file is highly dependent on the file type and the software that created the file.

 

FILES

lib/metadata.default.meta
built in default template for all file types (=file suffixes) for which no specific metadata.suffix.meta exists.

Do not change this file, it will be overwritten when upgrading the WA2L/WinTools package, create your own metadata.default.meta file in the etc/ directory.

etc/metadata.default.meta
default template for all file types (=file suffixes) for which no specific metadata.suffix.meta exists.

etc/metadata.suffix.meta
file type (=file suffix) specific template.

 

EXAMPLES

-

 

SEE ALSO

wintoolsintro(1), bib2xml.xml(4), metadata(1), metadata.cfg(4)

 

NOTES

-

 

BUGS

-

 

AUTHOR

metadata.template was developed by Christian Walther. Send suggestions and bug reports to wa2l@users.sourceforge.net .

 

COPYRIGHT

Copyright © 2020 Christian Walther

This is free software; see WA2LSimpleBackup/man/COPYING for copying conditions. There is ABSOLUTELY NO WARRANTY; not even for MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.


 

Index

NAME
SYNOPSIS
AVAILABILITY
DESCRIPTION
FILEFORMAT
OPTIONS
FILES
EXAMPLES
SEE ALSO
NOTES
BUGS
AUTHOR
COPYRIGHT

This document was created by man2html using the manual pages.
Time: 16:32:24 GMT, September 14, 2024