PublishWeb < System

This is a template topic for use with PublishPlugin. It illustrates how
to set up a topic in a web to simplify publishing.

To use it, take a copy of the raw text of this topic, and paste it into a new topic in your own web.

---+ Publish topics from the %WEB% web
   * Name of the URL and folder space inside =$Foswiki::cfg{PublishPlugin}{Dir}= and =$Foswiki::cfg{PublishPlugin}{URL}=. e.g. =test=, =prod=. Defaults to =''=, so publishes to the top of those.
      * Set PUBLISH_INSTANCE =
   * Name of a topic that contains a table that maps topic names to version numbers. This topic can be used to publish specific versions of listed topics.
      * Set PUBLISH_VERSIONS =    
   * Comma-separated list of [[PublishPlugin#WildcardPattern][wildcard patterns]] that match the names of topics to *include* 
      * Set PUBLISH_INCLUSIONS = *
   * Comma-separated list of [[PublishPlugin#WildcardPattern][wildcard patterns]] that match the names of topics to *exclude*
      * Set PUBLISH_EXCLUSIONS = Web*,Publish*
   * A [[#RegularExpression][regular expression]] that will cause a topic to be *excluded* if the RE matches the topic content
      * Set PUBLISH_FILTER =
   * Skin for published HTML
      * Set PUBLISH_SKIN = text
   * Comma-separated list of templates to use (defaults to view). Output will be generated for each template in this list (e.g. =view,print=). Note that =VIEW_TEMPLATE= will still override the template if it is set in specific topics (See %SYSTEMWEB%.SkinTemplates).
      * Set PUBLISH_TEMPLATES = view
   * Format to publish in (=file=, =pdf=, =tgz=, =zip=)
      * Set PUBLISH_FORMAT = file
   * If set, additional options that will be passed to the output generator
      * Set PUBLISH_EXTRAS =
   * Name of the publish history topic to us. Default is PublishPluginHistory
      * Set PUBLISH_HISTORY =
<form method="POST" name="rename" action="%SCRIPTURLPATH{rest}%/PublishPlugin/publish">
<input type="hidden" name="topic" value="%WEB%.%TOPIC%" />
<input type="hidden" name="configtopic" value="%WEB%.%TOPIC%" />
<input type="hidden" name="ping" value="%SERVERTIME%" />
<input type="submit" class="foswikiSubmit" value="Publish using this topic" />
</form>

This topic: System > PublishWeb
Topic revision: revision 1 (raw view)

Copyright © by the contributing authors. All material on this site is the property of the contributing authors.
Ideas, requests, problems regarding Foswiki? Send feedback