= Metadata =

The metadata abstraction is used in MoinLight to control the conversion of
wiki content from its [[Input|input]] form to its eventual [[Output|output]]
form.

The settings or properties retained by the conversion metadata are described
below.

<<TableOfContents(2,2)>>

== anchor ==

 Default:: `False`

Recognise the MoinLight anchor syntax.

== attachments ==

 Default:: `attachments`

The name used for attachment directories.

== category_pattern ==

 Default:: `^Category(?P<name>.*)`

A regular expression with a group called `name`, isolating a category name
from a pagename.

== common_attachments ==

 Default:: (none)

A boolean value indicating whether attachments should be stored in a single
directory, utilising a common group of files.

== document_index ==

 Default:: `index.html`

The filename to be incorporated into page links so that such links reference a
particular file instead of the page directory containing the file. This is
useful when generating HTML content to be browsed as local files.

== extract_included ==

 Default:: `False`

Indicate whether pages should be created for included page regions so that
they may be referenced by simplified `Include` macro instances.

== history ==

 Default:: `False`

Whether all available revisions of the input documents are to be processed.

== icon_sets ==

 Default:: `["Tango", "mate", "gnome"]`

The names of the supported icon sets used to provide icons and smileys in HTML
format output, searched in the given order for requested images.

== icons_dir ==

 Default:: `/usr/share/icons`

The location of the different icon sets in the filesystem.

== index_name ==

 Default:: `index.{format}`

The filename to be used for documents providing page content in a directory
[[#output_context|output context]]. This will inherit any specified setting
for the [[#document_index|document index]]. The `{format}` parameter will be
replaced with the [[#output_format|output format]].

== input_context ==

 Default:: `standalone`
 Alternatives:: `directory`, `moindirectory`

The form of the [[Input|input]] to be processed.

== input_encoding ==

 Default:: `utf-8`

The character encoding used in the input documents.

== input_filename ==

 Default:: (none)

The location of the input document or directory of documents.

== input_format ==

 Default:: `moin`

The default format of input documents.

== input_separator ==

 Default:: (none)

The separator used to structure hierarchical pagenames in an input directory.

== input_users_dir ==

 Default:: (none)

The location of Moin user record files. If this is not set, an attempt will be
made to find a directory called `user` as a sibling of the [[#input_filename|
input directory]].

== interwiki ==

 Default:: (none)

A mapping of identifiers to URLs, used to generate interwiki links.

== line_break ==

 Default:: `False`

Recognise the MoinLight line break syntax.

== link_format ==

 Default:: (depends on the [[#output_format|output format]])

The format of encoded links in converted documents. Typically, this will
conform to the general output format of the documents.

== macro_names ==

 Default:: (none)

Indicate which specific macros are to be expanded.

== macros ==

 Default:: (none)

Indicate whether macros are to be expanded.

== mw_separator ==

 Default:: `__`

The page hierarchy separator used in encoding attachment filenames for
MediaWiki.

== non_breaking_space ==

 Default:: `False`

Recognise the MoinLight non-breaking space syntax.

== original_pagename ==

 Default:: (none)

The name of the original page being processed where the current page may be
derived from this original page.

== output_context ==

 Default:: `standalone`
 Alternatives:: `directory`, `moindirectory`

The form of the [[Output|output]] to be processed.

== output_encoding ==

 Default:: `utf-8`

The character encoding used in the output documents.

== output_format ==

 Default:: `moin`

The default format of output documents.

== output_filename ==

 Default:: (none)

The location of the output document or directory of documents.

== output_separator ==

 Default:: (none)

The separator used to structure hierarchical pagenames in an output directory.

== pagename ==

 Default:: (none)

The name of the page being processed.

== pagename_titles ==

 Default:: (none)

A boolean value indicating whether the name of each page shall be used as its
title. If not set or set to a false value, the first top-level heading will be
used as a potentially prettier form of the page title, which is the convention
in certain wikis.

== revision_name ==

 Default:: `{revision}.{format}`

The filename to be used for documents providing page content in a directory
[[#output_context|output context]] for a specific revision. The default
produces `00000001.html` for the first revision in HTML format, for example.
The `{format}` parameter will be replaced with the [[#output_format|output
format]].

== root_pagename ==

 Default:: `FrontPage`

The pagename of the root document in a collection of documents.

== smileys ==

 Default:: (none)

A boolean value indicating whether certain text patterns should be interpreted
as smileys and used to produce appropriate images in the output.

== theme_name ==

 Default:: (none)
 Alternatives:: (see below)

Required for applying [[Themes|themes]] to output.

The software combines the given theme name with an output format to identify
the theme package to use. For example:

|| '''Theme Name''' || '''Format''' || '''Package'''    ||
|| `debian`         || `html`       || `debian.html`    ||
|| `default`        || `html`       || `default.html`   ||
|| `mercurial`      || `html`       || `mercurial.html` ||

It is only necessary to indicate the basic theme name, however.

== url_schemes ==

 Default:: `["file", "ftp", "http", "https", "irc", "mailto"]`

The URL schemes recognised when identifying bare URLs for linking when the
[[#urls|urls]] setting is set to a true value.

== urls ==

 Default:: (none)

A boolean value indicating whether bare URLs should be used to provide links
in the output.

== variables ==

 Default:: (none)

A mapping of names to values, used to generate variable substitutions.

== verbatim ==

 Default:: `False`

Recognise the MoinLight verbatim syntax.

== wikiwords ==

 Default:: (none)

A boolean value indicating whether wikiwords should be identified and used to
provide links in the output.
