Skip to end of banner
Go to start of banner

Part 5 - Creating a systems article template

Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 5 Next »

Overview

For the Systems article, create a form with some text-data blocks and some drop-down menus using list-data and list-option blocks.

Create the template

For the name of product, report on the page's title (Optional). 

For the product type, create a drop-down menu to choose between hardware or software, describing the nature of the system.

Create a text-data block for the product description:

Note that the parameter type=line means this is a single line input.

Next, create a drop-down menu to choose from a list of administrators/managers that may be the product owner.

See that we no longer have to create multiple list-option blocks to list specific users in Confluence. Nest the user-options block inside the list-data block, and then choose an existing user group in Confluence for the group parameter. 

The drop-down menu lists all the users from the chosen user group, like this:

Create a text-data block for a link to the product:

Create a drop-down menu for the identity provider of the product:

And now, some support contact information, using list-data and user-options block:

For the support contact field, choose type=autocomplete pameter to input user names like this:

Learn how you can a create a new article with this template in this tutorial.

Code

 Systems article template source code
<table class="relative-table wrapped" style="width: 52.3358%;">
  <colgroup>
    <col style="width: 21.4153%;"/>
    <col style="width: 78.3675%;"/>
  </colgroup>
  <tbody>
    <tr>
      <th>Name of product</th>
      <td>
        <div class="content-wrapper">
          <p>
            <ac:structured-macro ac:macro-id="3c61269c-886a-4735-aead-11e618c66ff2" ac:name="report-info" ac:schema-version="1">
              <ac:parameter ac:name="">content:title</ac:parameter>
            </ac:structured-macro>
          </p>
        </div>
      </td>
    </tr>
    <tr>
      <th colspan="1">Product Type</th>
      <td colspan="1">
        <div class="content-wrapper">
          <p>
            <ac:structured-macro ac:macro-id="6fbdaa1c-4a20-42b3-9775-0987258e3cf7" ac:name="list-data" ac:schema-version="1">
              <ac:parameter ac:name="blank">false</ac:parameter>
              <ac:parameter ac:name="name">KB system type</ac:parameter>
              <ac:parameter ac:name="separator">newline</ac:parameter>
              <ac:parameter ac:name="atlassian-macro-output-type">INLINE</ac:parameter>
              <ac:rich-text-body>
                <ac:structured-macro ac:macro-id="f95cb51f-44cf-45c2-aab5-3c26eb6aa718" ac:name="list-option" ac:schema-version="1">
                  <ac:parameter ac:name="label">Hardware</ac:parameter>
                  <ac:parameter ac:name="value">Hardware</ac:parameter>
                  <ac:rich-text-body>
                    <p>Hardware</p>
                  </ac:rich-text-body>
                </ac:structured-macro>
                <ac:structured-macro ac:macro-id="7d43e3a8-fa90-4b2f-ab03-3adbf531b0b7" ac:name="list-option" ac:schema-version="1">
                  <ac:parameter ac:name="label">Software</ac:parameter>
                  <ac:parameter ac:name="value">Software</ac:parameter>
                  <ac:rich-text-body>
                    <p>Software</p>
                  </ac:rich-text-body>
                </ac:structured-macro>
              </ac:rich-text-body>
            </ac:structured-macro>
          </p>
        </div>
      </td>
    </tr>
    <tr>
      <th>Description</th>
      <td>
        <div class="content-wrapper">
          <p>
            <ac:structured-macro ac:macro-id="8c6841f2-4f13-4e47-bad8-9c9dd2b22740" ac:name="text-data" ac:schema-version="1">
              <ac:parameter ac:name="name">System description</ac:parameter>
              <ac:parameter ac:name="width">100%</ac:parameter>
              <ac:parameter ac:name="type">line</ac:parameter>
              <ac:parameter ac:name="content">text</ac:parameter>
              <ac:parameter ac:name="atlassian-macro-output-type">INLINE</ac:parameter>
              <ac:rich-text-body>
                <p> </p>
              </ac:rich-text-body>
            </ac:structured-macro>
          </p>
        </div>
      </td>
    </tr>
    <tr>
      <th>Product Owner</th>
      <td>
        <div class="content-wrapper">
          <p>
            <ac:structured-macro ac:macro-id="ffbfea3e-07dd-436e-a1a2-201461aa8904" ac:name="list-data" ac:schema-version="1">
              <ac:parameter ac:name="name">System owner</ac:parameter>
              <ac:parameter ac:name="atlassian-macro-output-type">INLINE</ac:parameter>
              <ac:parameter ac:name="blankText">Not applicable</ac:parameter>
              <ac:rich-text-body>
                <ac:structured-macro ac:macro-id="2923114d-e48e-4cd8-ae4a-faf375af438f" ac:name="user-options" ac:schema-version="1">
                  <ac:parameter ac:name="groups">confluence-administrators</ac:parameter>
                  <ac:rich-text-body>
                    <p> </p>
                  </ac:rich-text-body>
                </ac:structured-macro>
              </ac:rich-text-body>
            </ac:structured-macro>
          </p>
        </div>
      </td>
    </tr>
    <tr>
      <th>URL</th>
      <td>
        <div class="content-wrapper">
          <p>
            <ac:structured-macro ac:macro-id="50b6ff9e-c1d6-4c13-a86a-561c1fbf7b41" ac:name="text-data" ac:schema-version="1">
              <ac:parameter ac:name="name">System URL</ac:parameter>
              <ac:parameter ac:name="width">100%</ac:parameter>
              <ac:parameter ac:name="type">line</ac:parameter>
              <ac:parameter ac:name="atlassian-macro-output-type">INLINE</ac:parameter>
              <ac:rich-text-body>
                <p> </p>
              </ac:rich-text-body>
            </ac:structured-macro>
          </p>
        </div>
      </td>
    </tr>
    <tr>
      <th>Identity Provider</th>
      <td>
        <div class="content-wrapper">
          <p>
            <ac:structured-macro ac:macro-id="637b352a-867c-4155-8946-d4d7a4cf50a8" ac:name="list-data" ac:schema-version="1">
              <ac:parameter ac:name="name">System provider</ac:parameter>
              <ac:parameter ac:name="separator">newline</ac:parameter>
              <ac:parameter ac:name="atlassian-macro-output-type">INLINE</ac:parameter>
              <ac:parameter ac:name="blankText">Not applicable</ac:parameter>
              <ac:rich-text-body>
                <ac:structured-macro ac:macro-id="89defb59-68e2-418c-b494-8f45eb7afe3a" ac:name="list-option" ac:schema-version="1">
                  <ac:parameter ac:name="label">Atlassian</ac:parameter>
                  <ac:parameter ac:name="value">Atlassian</ac:parameter>
                  <ac:rich-text-body>
                    <p>Atlassian </p>
                  </ac:rich-text-body>
                </ac:structured-macro>
                <ac:structured-macro ac:macro-id="56e6d80b-e6e9-40b0-88ee-7c9684a04ee5" ac:name="list-option" ac:schema-version="1">
                  <ac:parameter ac:name="label">Facebook</ac:parameter>
                  <ac:parameter ac:name="value">Facebook</ac:parameter>
                  <ac:rich-text-body>
                    <p>Facebook</p>
                  </ac:rich-text-body>
                </ac:structured-macro>
                <ac:structured-macro ac:macro-id="4abe3dff-2dab-4bb2-b0f1-138e55364777" ac:name="list-option" ac:schema-version="1">
                  <ac:parameter ac:name="label">Google</ac:parameter>
                  <ac:parameter ac:name="value">Google</ac:parameter>
                  <ac:rich-text-body>
                    <p> Google</p>
                  </ac:rich-text-body>
                </ac:structured-macro>
              </ac:rich-text-body>
            </ac:structured-macro>
          </p>
        </div>
      </td>
    </tr>
    <tr>
      <th colspan="1">Support contact</th>
      <td colspan="1">
        <div class="content-wrapper">
          <p>
            <ac:structured-macro ac:macro-id="2e2c8cb9-01fa-4f13-beee-e5ee7d173c1c" ac:name="list-data" ac:schema-version="1">
              <ac:parameter ac:name="multiple">true</ac:parameter>
              <ac:parameter ac:name="name">System support</ac:parameter>
              <ac:parameter ac:name="type">auto complete</ac:parameter>
              <ac:parameter ac:name="atlassian-macro-output-type">INLINE</ac:parameter>
              <ac:parameter ac:name="blankText">None</ac:parameter>
              <ac:rich-text-body>
                <ac:structured-macro ac:macro-id="a557b0e0-733b-402e-9fae-c9435a0e3626" ac:name="user-options" ac:schema-version="1">
                  <ac:parameter ac:name="groups">itsupport</ac:parameter>
                  <ac:rich-text-body>
                    <p> </p>
                  </ac:rich-text-body>
                </ac:structured-macro>
              </ac:rich-text-body>
            </ac:structured-macro>
          </p>
        </div>
      </td>
    </tr>
  </tbody>
</table>

Next

Part 6 - Using live templates to create KB articles

  • No labels