MoinLight

docs/wiki/Metadata

311:4b86f7f894b8
2021-10-26 Paul Boddie Fixed table feature padding patterns to consume only a single line.
     1 = Metadata =     2      3 The metadata abstraction is used in MoinLight to control the conversion of     4 wiki content from its [[Input|input]] form to its eventual [[Output|output]]     5 form.     6      7 The settings or properties retained by the conversion metadata are described     8 below.     9     10 <<TableOfContents(2)>>    11     12 == attachments ==    13     14  Default:: `attachments`    15     16 The name used for attachment directories.    17     18 == document_index ==    19     20  Default:: (none)    21     22 The filename to be incorporated into page links so that such links reference a    23 particular file instead of the page directory containing the file. This is    24 useful when generating HTML content to be browsed as local files.    25     26 == index_name ==    27     28  Default:: `index.html`    29     30 The filename to be used for HTML documents providing page content in a    31 directory [[#output_context|output context]]. This will inherit any specified    32 setting for the [[#document_index|document index]].    33     34 == input_context ==    35     36  Default:: `standalone`    37  Alternatives:: `directory`, `moindirectory`    38     39 The form of the [[Input|input]] to be processed.    40     41 == input_encoding ==    42     43  Default:: `utf-8`    44     45 The character encoding used in the input documents.    46     47 == input_filename ==    48     49  Default:: (none)    50     51 The location of the input document or directory of documents.    52     53 == input_format ==    54     55  Default:: `moin`    56     57 The default format of input documents.    58     59 == input_separator ==    60     61  Default:: (none)    62     63 The separator used to structure hierarchical pagenames.    64     65 == link_format ==    66     67  Default:: (depends on the [[#output_format|output format]])    68     69 The format of encoded links in converted documents. Typically, this will    70 conform to the general output format of the documents.    71     72 == mapping ==    73     74  Default:: (none)    75     76 A mapping of identifiers to URLs, used to generate interwiki links.    77     78 == output_context ==    79     80  Default:: `standalone`    81  Alternative:: `directory`    82     83 The form of the [[Output|output]] to be processed.    84     85 == output_encoding ==    86     87  Default:: `utf-8`    88     89 The character encoding used in the output documents.    90     91 == output_format ==    92     93  Default:: `moin`    94     95 The default format of output documents.    96     97 == output_filename ==    98     99  Default:: (none)   100    101 The location of the output document or directory of documents.   102    103 == root_pagename ==   104    105  Default:: `FrontPage`   106    107 The pagename of the root document in a collection of documents.   108    109 == theme_name ==   110    111  Default:: (none)   112  Alternatives:: (see below)   113    114 Required for applying themes to output. The names combine a theme name with an   115 output format. For example:   116    117 || '''Alternative''' || '''Theme''' || '''Format''' ||   118 || `default.html`    || `default`   || `html`       ||   119 || `mercurial.html`  || `mercurial` || `html`       ||