publish-config.xml

Overview

Note

In earlier versions of PageSeeder this file was publishConfig.xml instead of publish-config.xml.

This file will bind a publish script to an option in the user interface. Publish scripts are used for tasks such as the following:

  • import arbitrary document formats to PSML for editing,
  • export PSML to arbitrary document formats for presentation or interchange,
  • deliver PSML documents to a remote file system, API or web server.

When processing PSML documents, the publish config makes it possible to bind the script to any of the following:

  • document
  • folder
  • group

For detailed information see the documentation for <publishing>.

Example file

<publishing>
  <!-- sample 
  <action type="export">
    <source type="group" />
      <target name="export-group-psml">
       <description>Export all documents in this group</description>
             
                <param name="context" 
                      label="Context path"  
                    default="" 
                perspective="developer" />

                <param name="includes"
                      label="Documents to include" 
                    default="*,**/*" 
                perspective="developer" />

                <param name="excludes"
                      label="Documents to exclude" 
                    default="archive,attachments" 
                perspective="developer" />

                <param name="xrefdepth" 
                      label="Maximum depth of forward xrefs" 
                    default="0" min="0" max="8" 
                perspective="developer" />

                <param name="version"
                      label="Version to export" 
                      title="Version to export" 
                perspective="developer" />

                <param name="compare"
                      label="Version to compare"
                perspective="developer" />

                <param name="resolveimages"
                      label="Resolve images" 
                    default="true" 
                       type="checkbox"
                perspective="developer" />

                <param name="metadataonly"
                      label="Export metadata only" 
                    default="false"
                       type="checkbox"
                perspective="developer" />

                <param name="failonerror"
                      label="Fail on error" 
                    default="true"
                       type="checkbox" 
                perspective="developer" />

              </target>
          </action>  
    -->
          <action type="export">
           <source type="group" />
            <target name="export-allspec-allsource">
              <description>Export ALLsource document</description>
            </target>
          </action>

         <action type="export">
          <source type="group" />
           <target name="export-allspec-allabstract">
            <description>Export ALLabstract document</description>
          </target>
        </action>

        <action type="publish">
         <source type="folder" />
          <target name="publish-allspec-local-folder">
           <description>Publish to local website</description>
          </target>
        </action>

       <action type="upload">
        <source type="document" extension="docx" />
         <target name="import-allspec-worksection">
          <description>Import Word document as worksection (v0.1)
            </description>
               <param name="remove.original"
                     label="Remove original document" 
                   default="true" 
                      type="checkbox" /> 
    
               <param name="create.subfolder"
                     label="Create subfolder for document"
                   default="false"
                      type="checkbox" />
           </target>
         </action>

         <action type="publish">
           <source type="document" extension="psml"/>
            <target name="publish-server-website-document-psml">
             <description>Publish document to website
                    (http://allspec.allette.com.au)
                 </description>
            </target>
          </action>

          <action type="publish">
           <source type="folder" extension="psml"/>
             <target name="publish-server-website-folder">
               <description>Publish folder to website
                 (http://allspec.allette.com.au)
               </description>
            </target>
        </action>
    </publishing>

Created on , last edited on