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