<publishing> element

This article describes how the <publishing> element can be modified to provide custom processing for different types of documents. The content on this element determines the options that are presented to users when the Publisher is invoked.

See also PSML Ant scripts.

<publishing> is valid in the following files:

• document-config.xml – the <publishing> element is under the <document-config> element and controls processing for a specific document type.
• To access this file, go to the Document types administration page, Config column, then select the row for the document type.
• url-config.xml – the <publishing> element is under the <url-config> element and controls processing for a specific URL type.
• To access this file,
• Go to the Global template page, click Manage global types.
• Or, go to the Document types administration page, click the Edit global types button at top right, under heading URL types then Config column, select the row for the URL type.
• publish-config.xml– is the root element of the file and controls publishing across all groups, folders and documents or a batch of search results in a project.
• To access this file, from the project, administration menu, select Template > Template files > publish folder, then select the edit option on the right of the config file.

The configuration follows the structure below:

<publishing>
  <action ... />*
</publishing>

Behavior

The PageSeeder model allows the default functionality to be extended by adding the @override attribute to the <publishing> element.

<publishing override="true">
  <action ... />*
</publishing>

If the <publishing> element is not specified, or the config files doesn’t exist, options are inherited from the default files. To view the default document-config.xml and publish-config.xml, from the system administration menu, select Templates > Default files.

Element details

<action>

Each <action> defines:

<source>

In publish-config.xml, each <action> element must have a <source> element. The batch type requires PageSeeder v5.98 or higher and only works in the v6 UI. The <source> element can define:

<target>

Each <action> element must have one or more <target> elements that corresponds to each target in the Ant script. The <target> element defines:

Each <target> element must have a <description> element to describe the process in the user interface. Each <target> element can have one or more <param> elements for the specified parameters.

<param>

Each <param> element can have the following attributes and can also contain an <autosuggest> element when @type="document" .

Following are the available options when the value of @type is text:

• text – displays an input box for text to be entered manually.
• placeholder – can be used to display a hint in the box when no value has been specified.
• pattern – can specify a regular expression that the value must match to be submitted. This can constrain the format or value of the field.

When the value of @type is select, the <param> element can have one or more <value> elements for the valid choices.

• select – displays a drop-down list and allows only one value to be selected. The content of each <value> element is displayed as an option in the list.
• checkbox – displays a checkbox which has possible values of true or false.
• date – invokes a date picker interface and stores the value as ISO8601 (yyyy-mm-dd).
• number – displays a number field which allows only valid numbers as defined by the @min, @max and @step attributes.

The following options provide additional flexibility for users to select content for processing:

• documentversion – drop-down list of all document versions used in the current group.
• localdocumentversion – drop-down list of document versions in the current document.
• publicationid – drop-down list of all publication IDs in the current group.
• localpublicationid – drop-down list of publication IDs for the current document.
• documentlabel – drop-down list of document labels for the current group.
• documentstatus – drop-down list of document status values for the current group.
• fragmentlabel – drop-down list of fragment labels for the current group.
• document or folder – allows selection of a document or folder through browse. Sends four parameters to the publish script by adding the following suffixes to the parameter name: .group.name, .uri.path, .uri.id, .uri.document.id, .uri.document.type (e.g. if the name was dest the params would be dest.group.name, dest.uri.path, dest.uri.id, dest.uri.document.id, dest.uri.document.type ). Requires PageSeeder v5.9802 or higher.

Auto-suggest configuration

This uses the same search as the search box. It is configured through the following attributes on the <autosuggest> element. Requires PageSeeder v5.99 or higher.

Examples

File document-config.xml

Following is an example of the <publishing> element deployed to a document-config.xml file:

<publishing>
  <action type="publish">
    <target name="psml-to-website">
      <description>Publish to website</description>
    </target>
    <target name="psml-to-blog">
      <description>Publish to blog</description>
    </target>
  </action>
  <action type="export" >
    <target name="psml-to-pdf-columns" perspective="developer">
    <description>Export as PDF in 3 columns</description>
      <param name="depth"
             label="Depth of XRefs
             to publish"
             type="number"
             min="1"
             max="8" />
      <param name="isbn"
             type="text"
             label="ISBN"
             placeholder="Enter a valid ISBN number (97xxxxxxxxxxx)"
             pattern="97[89][0-9]{10}" />
      <param name="in-stock"
             type="checkbox"
             label="In Stock"
             default="true"
             perspective="developer" />
      <param name="language"
             type="select"
             label="Language"
             default="Spanish">
        <value>English</value>
        <value>French</value>
        <value>Spanish</value>
      </param>
    </target>
  </action>
</publishing>

File publish-config.xml

Following is an example of the <publishing> element deployed to a publish-config.xml file:

<publishing>
  <action type="export">
    <source type="document" extension="psml" />
    <target name="psml-to-pdf-columns" perspective="developer">
      <description>Export as PDF in 3 columns</description>
    </target>  
  </action>
  <action type="publish">
    <source type="folder" />
    <target name="psml-to-website">
      <description>Publish to website</description>
      <param name="depth"
             label="Depth of XRefs to publish"
             type="number"
             min="1"
             max="8" />
    </target>
  </action>
</publishing>