---
title: Meta Info Reference
inMenu: true
---
h2. Meta Information Reference

Following is a list of all the meta information items that are used in one way or another by a
plugin, be it a file handler plugin, a tag plugin...

<table class="metainfo">
<tr>
  <th>Name</th><th>Type</th><th>Example</th><th>Valid for</th><th>Description</th>
</tr>
<tr>
  <th>blocks</th>
  <td>Array of Arrays</td>
  <td>[[content, markdown], [sidebar, html]]</td>
  <td>Page/Template file</td>
  <td>Sets the name and format of content blocks. Each sub-array contains, in this order, the name
      of the block and its format.</td>
</tr>
<tr>
  <th>directoryName</th>
  <td>String</td>
  <td>Image Directory</td>
  <td>Any</td>
  <td>Only used if set on a directory index file; specifies the title of the directory for
      which it is the index file. If it is not specified, the title of the directory will be
      used.</td>
</tr>
<tr>
  <th>emoticonPack</th>
  <td>String</td>
  <td>bigeyes</td>
  <td>Page file</td>
  <td>Sets the emoticon package which should be used for the page.</td>
</tr>
<tr>
  <th>indexFile</th>
  <td>String</td>
  <td>getting.page</td>
  <td>Directory</td>
  <td>Sets the directory index file for the directory overriding the default value.</td>
</tr>
<tr>
  <th>inMenu</th>
  <td>Boolean</td>
  <td>true</td>
  <td>Any</td>
  <td>Specifies if the file/directory should appear in menus.</td>
</tr>
<tr>
  <th>lang</th>
  <td>String</td>
  <td>de</td>
  <td>Page file</td>
  <td>Sets the language for the page file. Has to be a valid ISO-639-1/2 character code for the language.</td>
</tr>
<tr>
  <th>linkAttrs</th>
  <td>Hash</td>
  <td>\{title: Hallo, class: extra}</td>
  <td>Any</td>
  <td>Specifies additional attribute-value pairs (in form of a Hash) that should be added to a link to the file/directory.</td>
</tr>
<tr>
  <th>link_callback</th>
  <td>String (Ruby code)</td>
  <td><code>"<a#{attrs}>#{link_text} + some text</a>"</code></td>
  <td>Any</td>
  <td>
    Can be used to customize the link generated for the node. The available variables are: <br />

    +node+: The node to which the link points.<br />
    +ref_node+: The reference node.<br />
    +attrs+: A string of compiled HTML attributes that should be on the link element.<br />
    +link_text+: The text for the link.<br />
    +context+: An optional hash with context information. The key :caller is set to the plugin which invoked
               the link generation, e.g. MenuStyle/Vertical or Tag/Langbar. Optional other key-value pairs are
               provided depending on the plugin.
  </td>
</tr>
<tr>
  <th>omitIndexFileInBreadcrumbTrail</th>
  <td>Boolean</td>
  <td>false</td>
  <td>Index file</td>
  <td>Controls whether the index file should appear in a breadcrumb trail despite the setting of the
      {param: Tag/BreadcrumbTrail:omitIndexFile} parameter.
  </td>
</tr>
<tr>
  <th>orderInfo</th>
  <td>Integer</td>
  <td>15</td>
  <td>Any</td>
  <td>Sets the ordering information for the file/directory. The value 0 is used as default and means 'not set'.
      You should only use numbers greater than zero. However, if you want a menu item to always appear as first item,
      it is recommended to use the value -1. When sorting nodes, the @orderInfo@ value is used first. If the values for both
      nodes are the same, then they are sorted according to their @title@ meta information.
  </td>
</tr>
<tr>
  <th>outputNameStyle</th>
  <td>String</td>
  <td>[:name, [".", :lang], ".html"]</td>
  <td>Page file</td>
  <td>Sets a custom output name style for the specified page file only. The basename is substituted for the value @:name@
      and the language for the value @:lang@. Strings are used verbatim. If @:lang@ is specified in a sub-array, the whole
      sub-array is omitted, if the parameter {param: File/PageHandler:defaultLangInFilename} is false.
  </td>
</tr>
<tr>
  <th>template</th>
  <td>String</td>
  <td>my.template</td>
  <td>Page/Template file</td>
  <td>Sets the template for the page/template file overriding the default value. If set to @nil@, no
      template is used for the page/template file!</td>
</tr>
<tr>
  <th>title</th>
  <td>String</td>
  <td>New Title</td>
  <td>Any</td>
  <td>Sets the title for the file/directory.</td>
</tr>
<tr>
  <th>useERB</th>
  <td>Boolean</td>
  <td>false</td>
  <td>Page/Template file</td>
  <td>Specifies if the content blocks of the page/template file should be processed with ERB overriding the default value.</td>
</tr>
</table>