Use the Publish Settings page to control the way a template/profile appears in an implementation guide.

You can control the following:

  • Generate and customize code samples to associate with the template.
  • Control whether one or more constraints has its own heading in the implementation guide.

View the Publish Settings page

Select Publish Settings from the Template Viewer's Quick Buttons.

Constraint Headings

For complex template/profile structures, it is best practice to document certain elements of the template/profile in greater detail.

Use the Constraints tab of the Publish Settings page to add headings to constraints that appear in an implementation guide. This allows complex templates to be broken into sections within the implementation guide.

Add a Heading to a Constraint

  1. In the Constraints section of the Publish Settings page, select Edit for the constraint you want to edit.
  2. To add to the constraint heading text, select the Heading check box. The Heading Description box appears.
  3. Enter text in the Heading Description, Description, and Label boxes. The text appears as shown in the example below.
  4. To add an inline code sample, select Add. The Edit Constraint Sample window appears. Enter a Name for the sample, and enter the sample code in the Sample Contents box, then select OK. The sample name appears in the sample list.
  5. When finished, select OK. Heading text, Description text, Label text, and Sample Code are added to the selected constraint. The effect is shown below.
  6. When finished, select Save in the Edit Publish Settings.

Samples

Use the Template Samples tab of the Publish Settings page to generate, customize, and format code samples to associate with a particular template.

Generate a Code Sample

  1. In the Template Samples tab, select Add. The Edit Sample page appears.
  2. Enter a Name for the sample.
  3. Enter or paste the text you want to use in the sample, or select Generate to create a code sample based on the template's constraints.
  4. If you generated a sample, edit it as needed.
  5. To format the sample automatically, applying standard indentation, Format and Indent.
  6. When finished, select OK. The sample is saved, and is available for export with the implementation guide.