Reference Manuals

From Fantasy Grounds Wiki
Jump to: navigation, search

Overview

To create a reference manual view from within your module, you will need to create a link somewhere within your existing module.

To point to the navigation portion of the reference manual, use a link with a class value of "reference_manual" and a recordname value that points to the navigation data for the reference manual within your module.

To point to a specific reference manual page outside of the reference manual navigation, use a link with a class value of "referencemanualpage" and a recordname value that points to the specific reference manual page data within your module.

Updated on September 2, 2016 using Fantasy Grounds v3.2.0.

Navigation

Here is the expected data structure for the navigation portion of the reference manual data. Any tags or text which can be uniquely specified by the module creator will be encapsulated in brackets[]. Ellipses indicate that multiple entries can be included at that level.

<[reference_manual_navigation_data_path]>
  <chapters>
    <[chapter_00]>
      <name type="string">[Chapter Name]</name>
      <subchapters>
        <[subchapter_00]>
          <name type="string">[Subchapter Name]</name>
          <refpages>
            <[refpage_00]>
              <listlink type="windowreference">
                <class>reference_manualtextwide</class>
                <recordname>[reference_manual_page_data_path]</recordname>
                <description><field>name</field></description>
              </listlink>
              <name type="string">[Page Name]</name>
              <keywords type="string">[List of Keywords to be searchable separated by spaces]</keywords>
            </[refpage_00]>
            ...
          </refpages>
        </[subchapter_00]>
        ...
      </subchapters>
    </[chapter_00]>
    ...
  </chapters>
</[reference_manual_navigation_data_path]>

Reference Manual Pages

Here is the expected data structure for the page portion of the reference manual data. Any tags or text which can be uniquely specified by the module creator will be encapsulated in brackets[]. Ellipses indicate that multiple entries can be included at that level.

<[refpage_00]>
  <name type="string">[Page Name]</name>
  <text type="formattedtext">[Optional. Any formatted text to display before the manual data.]</text>
  <blocks>
    <[block_01]>
      <blocktype type="string">[See below]</blocktype>
      <align type="string">[See below]</align>
      <size type="string">[Only used for image/token blocks. Comma delimited width and height of image/token.]</size>
      <frame type="string">[Only used for text blocks. See below.]</size>
      <image type="image"><bitmap>[Only used for image blocks. Local file path to image within the module.]</bitmap></image>
      <imagelink type="windowreference">
        <class>[Only used for images. Window class to use for link.]</class>
        <recordname>[Only used for images. Data path to use for link.]</recordname>
      </imagelink >
      <picture type="token">[Only used for token blocks. Local file path to token within the module.]</picture>
      <icon type="string">[Only used for icon blocks. Name of ruleset icon asset to display.</icon>
      <caption type="string">[Only used for image/token/icon blocks. Caption string to show below image.]</caption>
      <captionlink type="windowreference">
        <class>[Only used for captions. Window class to use for link.]</class>
        <recordname>[Only used for captions. Data path to use for link.]</recordname>
      </captionlink>
      <text type="formattedtext">[Only used for text blocks. Textual information to display]</text>
      <text2 type="formattedtext">[Only used for multi-column text blocks. Textual information to display]</text2>
    </[block_01]>
    ...
  </blocks>
</[refpage_00]>

Here are the valid field values:

  • blocktype = "text" (default), "image" (standard image), "picture" (token image), "icon" (icon ruleset asset), "header" (single column text/frame)
  • align = "center" (default, 1-column), "left" (1-column), "right" (1-column), "left,right" (2-column), "right,left" (2-column)
    • If 1 value is specified in the align field, then only the value specified in block type (text, image, picture) will be used, and it will always be centered.
    • If 2 values are specified in the align field, then it is always assumed that there is a text column, and that the text column is assigned the first alignment value. The second alignment value will then be applied to the text2, image or picture field.
  • frame = "sidebar", "text1", "text2", "text3", "text4", "text5", "book", "page", "picture", "pink", "blue", "brown", "green"
    • Frames are defined by the ruleset. Any frame defined whose name starts with "referenceblock-" can be used. The ones listed here are included with CoreRPG ruleset.

4E Exception

The 4E ruleset used a precursor of the current reference manual to display rulebook data, but we wanted to support the existing content people had already parsed for 4E with community tools.

Please replace the following tags above for 4E manuals only:

  • <chapters> → <chapter>
  • <subchapters> → <section>
  • <refpages> → <article>