Access Keys:
Skip to content (Access Key - 0)

Notation

Step 4 - Create New Macros


The following macros need to be created:

{cagrid-x.x-docs-nav}
{cagrid-x.x-installer-link}
{cagrid-x.x-release-notes}
{cagrid-x.x-source-link}
{gaardsui-x.x-download-link}
{syncgts-x.x-download-link}

Creating Macros

Use the old macros as template. Begin by copying the old macro:

  1. Log into 'Site Administration' by selecting Edit --> Administration --> Site Administration
  2. Select User Macros from the "Configuration" section in the panel on the left.
  3. Locate the latest version of the macro that you wish to create and select Edit.
    1. For example, to create {cagrid-x.x-docs-nav}, find {cagrid-1.4-docs-nav} and select the edit link for that macro.
  4. Note the definitation for the macro, including the selections for "Macro Body Processing" and "Output Format".
  5. Select and Copy all of the text in "Template"
  6. Select Cancel

Copy the old macro to a new macro:

  1. Under the "Create a User Macro" heading, select Click here to create a new User Macro
  2. Enter the new Macro Name and Macro Title. These fields should be the same. Follow the naming format of the old macro.
  3. Select the same definitions for the user macro that the old macro had.
  4. Paste the copied text from the old macro into Template
  5. Change the text as necessary so that links point to the new locations for the upcoming release.

In many cases, the locations of the latest release is not known until the release is actually made. However, by creating these macros now, you can save some time later when the release is made and the new documentation goes live. By looking at the links, you can guess what the new location will be, assuming the new location will following the same naming and location format as the previous version.

However, since these locations may not be final or you may guess wrong, these macros will need to be checked to ensure that they are correct and working when the new release is announced and goes live.

Last edited by
Sarah Honacki (705 days ago)
Adaptavist Theme Builder Powered by Atlassian Confluence