RenderPublishWeb

Publish a web with a set of parameters

Documentation

Parameters

• theTOPICS - The topics to be included and excluded from publication. Default: %BASEWEB%.*,-*.Web*,-*.Publish*.
• theUNPUBLISHED - Handling of referred topics. Default: rewrite.
• theVERSIONS - Reference to the versions topic. No default.
• thePUBLISHSKIN - The skin to be used for publication. Default: publish,pattern.
• theEXTRAS - Preferences for use in topics during publication. No default.
• theENABLEPLUGINS - Plugins to be enabled or disabled during publishing. No default
  • The following are disabled by default in the PublishPlugin: -CommentPlugin,-EditRowPlugin,-EditTablePlugin,-NatEditPlugin,-SubscribePlugin,-TinyMCEPlugin,-UpdatesPlugin
• theTEMPLATE - See documentation. Default: view.
• theHISTORY - The web.topic name where the publishing history is written. Default: %BASEWEB%.!PublishHistory.
• theFORMAT - the format to publish. Default:= file=
• theOUTFILE - the top directory under {Plugins}{PublishPlugin}{Dir} (/home/foswiki/foswiki-current/pub/publish) Default: .
• theRELATIVEDIR - The subdirectory under pub/publish where the published topics are saved. No default.
• theDEBUG = debug flag. No default.

additional

• PublishPlugin: set copyexternal=off DONE
• = = = = = = == set enableplugins=-CommentPlugin,-EditRowPlugin,-EditTablePlugin,-NatEditPlugin,-SubscribePlugin,-TinyMCEPlugin,-UpdatesPlugin DEFAULTS!!
• = = = = = = == set outfile=/ DONE

Implementation

%STARTINCLUDE%
<form method="POST" name="publush" action="%SCRIPTURLPATH{rest}%/PublishPlugin/publish">
<input type="hidden" name="topics" value="%theTOPICS{ default="%BASEWEB%.*,-*.Web*,-*.Publish*"}%" />
<input type="hidden" name="unpublished" value="%theUNPUBLISHED{ default="rewrite"}%" />
<input type="hidden" name="versions" value="%theVERSIONS{ default=""}%" />
<input type="hidden" name="publishskin" value="%thePUBLISHSKIN{ default="publish2,pattern"}%"  />
<input type="hidden" name="extras" value="%theEXTRAS{default=""}%" />
<input type="hidden" name="enableplugins" value="%theENABLEPLUGINS{default="-CommentPlugin,-EditRowPlugin,-EditTablePlugin,-NatEditPlugin,-SubscribePlugin,-TinyMCEPlugin,-UpdatesPlugin"}%" />
<input type="hidden" name="template" value="%theTEMPLATE{ default="view"}%" />
<input type="hidden" name="copyexternal" value="%theCOPYEXTERNAL{ default="0"}%" />
<input type="hidden" name="history" value="%theHISTORY{ default="%BASEWEB%.PublishHistory"}%" />
<input type="hidden" name="format" value="%theFORMAT{ default="file"}%" />
<input type="hidden" name="outfile" value="%theOUTFILE{default="file"}%" />
<input type="hidden" name="relativedir" value="%theRELATIVEDIR{default="%BASEWEB%"}%" />
<input type="hidden" name="debug" value="%theDEBUG{default=""}%" />
<input type="hidden" name="ping" value="%SERVERTIME%" />
<input type="submit" class="foswikiSubmit" value="Publish %BASEWEB%" />
</form>

<noautolink>
With the following parameters:
   * *topics:* %theTOPICS{ default="%BASEWEB%.*,-*.Web*,-*.Publish*" }%
   * *template:* %theTEMPLATE{ default="view" }%
   * *publishskin:* %thePUBLISHSKIN{ default="publish2,pattern" }%
   * *format:* %theFORMAT{ default="file" }%
   * *copyexternal:* %theCOPYEXTERNAL{ default="0" }%
   * *history:* %theHISTORY{ default="%BASEWEB%.PublishHistory" }%
   * *unpublished:* %theUNPUBLISHED{ default="rewrite" }%
   * *versions:* %theVERSIONS{default="" }%
   * *extras:* %theEXTRAS{default="" }%
   * *enableplugins:* %theENABLEPLUGINS{default="-CommentPlugin,-EditRowPlugin,-EditTablePlugin,-NatEditPlugin,-SubscribePlugin,-TinyMCEPlugin,-UpdatesPlugin"}%
   * *enableplugins:* %theENABLEPLUGINS{default="" }%
   * *outfile:* %theOUTFILE{default="file"}%
   * *relativedir:* %theRELATIVEDIR{default="%BASEWEB%" }%
   * *debug:* %theDEBUG{default="" }%
</noautolink>
%STOPINCLUDE%

Test

• topics: Applications/Support.*,-*.Web*,-*.Publish*
• template: view
• publishskin: publish2,pattern
• format: file
• copyexternal: 0
• history: Applications/Support.PublishHistory
• unpublished: rewrite
• versions:
• extras:
• enableplugins: -CommentPlugin,-EditRowPlugin,-EditTablePlugin,-NatEditPlugin,-SubscribePlugin,-TinyMCEPlugin,-UpdatesPlugin
• enableplugins:
• outfile: .
• relativedir:
• debug: