Difference: PublishPlugin (1 vs. 7)

Revision 7

14 Feb 2014 - Main.AdminUser

Line: 1 to 1
	PublishPlugin Generates a static view of a web, as HTML files on disc, or as a `PDF`, or as a `zip` or `tgz` archive file, or by uploading directly to an FTP server.

Revision 6

14 Feb 2014 - Main.AdminUser

<-- -->

Line: 1 to 1

PublishPlugin

Generates a static view of a web, as HTML files on disc, or as a PDF, or as a zip or tgz archive file, or by uploading directly to an FTP server.

Line: 52 to 52

You can also create a permanent topic in a web to help with a repeated publishing process.

Most publishing tasks will only require setting the immediately visible options.

Changed:

<
< Other more advanced options can be accessed by opening the collabsible sections.

>
> Other more advanced options can be accessed by opening the collapsible sections.

%ADDTOHEAD{text=""}%

Line: 117 to 95

Changed:

<
<

Choose what to publish

>
>

Choose what to publish			URL Parameter

Line: 127 to 106

Changed:

<
< The Web to publish.

>
> The Web to publish. This is required to provide a context for the publishing process (e.g. web preference settings), even if all topics in the topiclist have explicit web names.

web

Line: 135 to 114

Changed:

<
< Include (wildcard)

>
> Topic List

Changed:

<
<

>
>

Changed:

<
< Comma-separated list of wildcard patterns that match the names of topics to include. Use * for all topics.

>
>

Comma-separated list of topic names. Leave blank to publish all topics in the web (as filtered by inclusions and exclusions).
You can use Foswiki macros (such as %SEARCH) in this list - for example, to include the contents of a topic that contains a list of topic names in a bulleted list, use %SEARCH{"^ \*" type="regex" nonoise="on" topic="TheTopic" format="$pattern(.*?^\s*\*\s*(.*?)$.$)"}%.

You can also use the Bookmaker (see Using Bookmaker, below) to build such lists, and include them using the %BOOKLIST{"Bookweb.BookName"}% macro.

A non-blank topiclist is still subject to filtering against inclusions and exclusions.

Note that this list can include topics in other webs, by referring to them using the Web.TopicName syntax.

Changed:

<
< inclusions

>
> topiclist

Added:

>
>

Changed:

<
< Exclude (pattern)

>
> Include filter

Changed:

<
<

>
>

Changed:

<
< Comma-separated list of wildcard patterns that match the names of topics to exclude. Leave blank to include all topics.

>
>

Comma-separated list of wildcard patterns that match the names of topics to include. This acts as a filter on the topic list. Use * to publish all topics in the list.

`inclusions`
Exclude filter		Comma-separated list of wildcard patterns that match the names of topics to exclude. This acts as a filter on the topic list. Leave blank to include all topics in the topic list.

exclusions

Changed:

<
<

>
>

Changed:

<
< Versions (topic)

>
> Versions

Changed:

<
<

>
>

Name of a topic that contains a table, each row of which maps a topic names to the version of that topic to publish.

Changed:

<
<

Leave blank to publish the most recent version of each topic.

The table can be generated by a %SEARCH{}% or other macro. For example: |Web.TopicName|1.33|.
If a topic does not appear in the table, the most recent version will be published.

>
> The table can be generated by a %SEARCH{}% or other macro. For example: |Web.TopicName|1.33|.
If a topic does not appear in the table, the most recent version will be published.

versions

Changed:

<
<

>
>

Changed:

<
< Filter topic contents (regex)

>
> Filter topic contents

Changed:

<
<

>
>

Changed:

<
< A regular expression that will cause a topic to be excluded if the RE matches the topic content.
Leave blank to include all topics.

>
> A regular expression that will cause a topic to be excluded if the RE matches the topic content.

Changed:

<
< filter

>
>

topicsearch

Processing options

Default processing of topics for publishing tries to render the topics as closely to the way they are viewed in the wiki as possible. These options provide a finer level of control.

Added:

>
>

Publish skin The skin provides the template for how topics are published. See Skins for more informations on skins. You are recommended to pick basic_publish, or plain, or a print skin. Your installation may also offer a special export or publish skin.
The view template is used to generate published pages, so view.basic_publish.tmpl is the template that will be used to generate the output. You can preview any topic in this skin simply by appending ?skin=basic_publish to the end of the view URL. Note that the standard VIEW_TEMPLATE template override still works when publishing. publishskin

Enable plugins (plugin names)

Changed:

<
<

>
>

Changed:

<
< Comma-separated list of Plugins to enable during publish. Leave blank to enable all plugins.
You are recommended to disable any plugins that generate buttons in the output.

>
>

Comma-separated list of Plugins to enable during publishing.

If you leave this field blank then all plugins enabled in the wiki will be run when generating the published output. You are recommended to disable any plugins that generate interactive buttons in the output.

enableplugins

Added:

>
>

Templates

Comma-separated list of template names.

By default the plugin uses the default view templates when it renders topics for publishing. You can change this to a list of one or more templates that you want to render using.

For example, you might want to use viewpdf to render a PDF version of the topic (if you have this action available). See Skins for a list of the template files available by default.

templates

<-- -->

Output options

Line: 223 to 283

Deleted:

<
<

Publish skin

The skin provides the template for how topics are published. See Skins for more informations on skins.

You are recommended to pick basic_publish, or plain, or a print skin. Your installation may also offer a special export or publish skin.

The view template is used to generate published pages, so view.basic_publish.tmpl is the template that will be used to generate the output. You can preview any topic in this skin simply by appending ?skin=basic_publish to the end of the view URL. Note that the standard VIEW_TEMPLATE template override still works when publishing.

skin

Output format

Line: 267 to 312

history

Changed:

<
<

<-- WEB OPTIONS -->

>
>

<-- FILE OUTPUT OPTIONS -->

Changed:

<
<

Web options

>
>

File output options

Changed:

<
< Web options are only relevant for web output formats (file and ftp) The web formats generate a sitemap.xml, and can also generate default.htm, index.html and google site verification files.

>
> File output options are relevant when output is being written to local files on disc.

Changed:

<
<

>
>

Output file Specify the name of the target output file (or directory), used when the output is going to a files e.g. file, pdf, zip, tgz outfile

Google file

Changed:

<
<

>
>

Generates the "HTML verification file" needed to verify your site claim.

Line: 290 to 351

googlefile

Changed:

<
<

>
>

Default page (topic)

Line: 302 to 363

defaultpage

Changed:

<
<

>
>

Relative directory

Changed:

<
<

>
>

Path of a directory relative to {PublishPlugin}{Dir} where you want the output generated. '/' means generate the output directly in

Line: 317 to 378

relativedir

Changed:

<
<

>
>

Relative URL

Changed:

<
<

>
>

The base URL that your published Foswiki topics will reside at, for instance to create different publishing instances like dev, test and public. Use / if you will publish to the root of your site. See also Google webmaster tools.

Line: 331 to 392

relativeurl

Added:

>
>

<-- FTP OPTIONS -->

Changed:

<
<

FTP options

>
>

FTP output options

Changed:

<
< FTP options are only relevant if the output format is ftp.
The FTP output generator was written by Foswiki:Main.SvenDowideit.

>
> FTP output options are only relevant if the output format is ftp.

Added:

>
>

Server address

Line: 393 to 461

destinationftppassword

Changed:

<
<

>
>

Fast publish

Line: 407 to 475

fastupload

Added:

>
>

<-- OTHER OUTPUT OPTIONS -->

Line: 414 to 486

Added:

>
> Some output generators (e.g. pdf) support extra options.

Extras

Line: 421 to 502

Changed:

<
< Some output generators support extra options (e.g. for pdf, you can add htmldoc command-line parameters here, such as --linkstyle underline).

>
> Some output generators support extra options (e.g. for pdf, you can add htmldoc command-line parameters here, such as --linkstyle underline). These options are passed directly to the output generator.

extras

Added:

>
>

<-- SUBMIT -->

Line: 482 to 567

rel='nofollow'>Publish this page%TMPL:END%

Added:

>
>

Using Bookmaker

The Bookmaker allows you to select a number of topics by visiting them in turn and adding them to the book. Once your book is complete, you can return to this page to publish it.

To start the bookmaker, enable the BookmakerPlugin, and revisit this page to enable the interface. Once the bookmaker is running, visit the pages you want to add to the book and add them to the book. Once you are finished, use the bookmaker interface to return to this page to publish the results. To publish a book generated by Bookmaker, use the %BOOKLIST{"Bookweb.BookName"}% macro in the topiclist parameter.

Using a Publish Topic (configtopic)

You can create a publish topic in a web that contains all the details needed to publish that web. This is just a topic with a series of standard preference settings (which correspond to the form parameters) in it. You can use the PublishWeb topic in this web as a template for your own topics.

Line: 546 to 639

configuration.

Info

Changed:

<
< This add-on started life as the GenHTMLAddon, written by Foswiki:Main/CrawfordCurrie at Motorola. It was then extended by Eric Scouten, and then further fixed and enhanced by Foswiki:Main/CrawfordCurrie (http://c-dot.co.uk). It has also been extended by Foswiki:Main/SvenDowideit and Foswiki:Main/MartinCleaver, and most recently refactored for Foswiki by Foswiki:Main/CrawfordCurrie.

>
> This add-on started life as the GenHTMLAddon, written by Foswiki:Main/CrawfordCurrie at Motorola. It was then extended by Eric Scouten, and then further fixed and enhanced by Foswiki:Main/CrawfordCurrie (http://c-dot.co.uk). It has also been extended by Foswiki:Main/SvenDowideit and Foswiki:Main/MartinCleaver, and most recently refactored for Foswiki by Foswiki:Main/CrawfordCurrie. Other significant contributors are Foswiki:Main.ArthurClemens and Foswiki:Main.MichaelDaum.

Changed:

<
<

Authors:

Foswiki:Main/CrawfordCurrie, Eric Scouten, Foswiki:Main.SvenDowideit, Foswiki:Main.MartinCleaver, Foswiki:Main.ArthurClemens

>
>

Author:

Foswiki:Main/CrawfordCurrie

Dependencies:

Name	Version	Description
File::Spec	>0	Required. Used to analyse URL paths.
File::Copy	>0	Required. Used to move files around.
File::Path	>0	Required to manipulate directories.
File::Temp	>0	Required for temporary files.
LWP	>0	Optional. Used to include images referenced by absolute URLs
Archive::Zip	>=0	Optional. Required to generate .zip output
Archive::Tar	>=0	Optional. Required to generate .tgz output
Net::FTP	>0	Optional. Required for ftp publishing.
htmldoc		Optional. Required to generate .pdf output
Digest::MD5	>0	Optional. Required for fast upload to ftp servers.

License:

GPL

Changed:

<
<

Version:	6222 (2010-02-05)
Release:	05 Feb 2010

>
>

Version:	11251 (2011-03-28)
Release:	2.2.0

Change History:

Changed:

<
<

05 Feb 2010	Documentation update.
12 Jan 2010	Foswikitask:Item2557: fixed publish head elements added by ADDTOHEAD
11 Jan 2010	Foswikitask:Item2615: fixed finding resources not inside quotes
30 May 2009	Foswikitask:Item8168: fixed genopt (extras)
22 May 2009	Foswikitask:Item8165: fixed missing BASEWEB and other internal preferences. This was resulting in the wrong web being used for some operations
16 May 2009	Foswikitask:Item1626: fixed META{"formfield" Foswikitask:Item8150: (Marc Schaefer) fix for -skin parameter Foswikitask:Item1557: doc fix Foswikitask:Item1585: allow history topic in different web Foswikitask:Item871: add missing newline at start of topic text. Foswikitask:Item1449: topic publisher was not popping the context correctly Foswikitask:Item1632: improve backporting support
18 Mar 2009	Foswikitask:Item804: automatically create publish dir Foswikitask:Item8078: support publishing to a subdir of the publish dir, under url param control
14 Feb 2009	Foswikitask:Item1033: fixed button in PublishWeb
27 Nov 2008	Foswikitask:Item8019: refactored as a plugin and tested in Foswiki
27 Oct 2008	Item5385: Fixed doc for configtopic Item5388: $WEB and $TOPIC were not correct in %IF statements Item5390: remove comments from .css before processing for included resoures Item5706: Improved FTP upload process for incrementally maintained webs Item6029: expand config topic on load to support use of searches Item6030: respect VIEW_TEMPLATE in published topics Item6092: expand common tags in configtopic Item6094: move sitemap options into base file generator Item6110: rename settings in config topic to avoid clashes with other plugins
11 Dec 2007	Item5099 fixed
10 Nov 2007	Tested on 4.2.0. Item4624:, Item4625: Item4830: fixed. Item4825: added a basic skin to avoid the confusion caused by `text` skin. Item4951: added interface to allow management of output files
13222	fixed ftp publish, added doco, and added enabled plugin selection funcitonality
13064	Item3722 worked around core attaching URL params to internal URLs

| 12961 | Item3671 cannot publish without write access to history topic, so

>
>

2.2.0 (28 Mar 2011)	Foswiki:Tasks/Item8225: fix handling of plugin contexts Item2635: make sure index.html is generated Foswiki:Tasks/Item10529: test integration with BookmakerPlugin? via new topiclist parameter
2.1.7 (01 Nov 2010)	Foswikitask:Item8658: fix rest output when publishing to file, pdf and ftp
2.1.6 (29 Oct 2010)	Foswikitask:Item8522: support for Foswiki 1.1.x and also 1.0.x+ZonePlugin Foswikitask:Item1638: fixed finding resources with parameters (e.g. `?t=2365421`)
2.1.5 (05 Feb 2010)	Documentation update.
2.1.4 (12 Jan 2010)	Foswikitask:Item2557: fixed publish head elements added by ADDTOHEAD
2.1.3 (11 Jan 2010)	Foswikitask:Item2615: fixed finding resources not inside quotes
2.1.2 (30 May 2009)	Foswikitask:Item8168: fixed genopt (extras)
2.1.1 (22 May 2009)	Foswikitask:Item8165: fixed missing BASEWEB and other internal preferences. This was resulting in the wrong web being used for some operations
2.1.0 (16 May 2009)	Foswikitask:Item1626: fixed META{"formfield" Foswikitask:Item8150: (Marc Schaefer) fix for -skin parameter Foswikitask:Item1557: doc fix Foswikitask:Item1585: allow history topic in different web Foswikitask:Item871: add missing newline at start of topic text. Foswikitask:Item1449: topic publisher was not popping the context correctly Foswikitask:Item1632: improve backporting support
2.0.2 (18 Mar 2009)	Foswikitask:Item804: automatically create publish dir Foswikitask:Item8078: support publishing to a subdir of the publish dir, under url param control
2.0.1 (14 Feb 2009)	Foswikitask:Item1033: fixed button in PublishWeb
2.0.0 (27 Nov 2008)	Foswikitask:Item8019: refactored as a plugin and tested in Foswiki
1.6.5 (27 Oct 2008)	Item5385: Fixed doc for configtopic Item5388: $WEB and $TOPIC were not correct in %IF statements Item5390: remove comments from .css before processing for included resoures Item5706: Improved FTP upload process for incrementally maintained webs Item6029: expand config topic on load to support use of searches Item6030: respect VIEW_TEMPLATE in published topics Item6092: expand common tags in configtopic Item6094: move sitemap options into base file generator Item6110: rename settings in config topic to avoid clashes with other plugins
1.6.4 (11 Dec 2007)	Item5099 fixed
1.6.3 (10 Nov 2007)	Tested on 4.2.0. Item4624:, Item4625: Item4830: fixed. Item4825: added a basic skin to avoid the confusion caused by `text` skin. Item4951: added interface to allow management of output files
1.6.2	fixed ftp publish, added doco, and added enabled plugin selection funcitonality
1.6.1	Item3722 worked around core attaching URL params to internal URLs

| 1.6.0 | Item3671 cannot publish without write access to history topic, so

security now checked early. Item3619 Cleaned up error handling from writers. Item3675 added history topic to record changeset. Plus major refactoring of main class to get rid of some of the cruft that had built up from many authors. Item2726: uses getExternalResource now, so should obey proxy settings (untested) |

Changed:

<
<

12824	Added support for new internal api - no user changes
12708	Added UI for FTP. Added .spec file. Fixed Item3515 and Item2725
12028	Michael Daum - create a new TWiki object for every topic, don't reuse the current one (Item3139)
10412	Correction to the correction for anchors.
10345	Correction to support anchors in URLs properly
10242	Martin Cleaver - changes to allow generation of viewprint and viewxxx when specified by TEMPLATE; multiple INSTANCE (dev/test/prod); (Item2269)
10063	Bugfix Item2216
10006	Crawford Currie - fixed problem where it was failing to remove <base> tags completely (Item2200)
9986	Crawford Currie - added doc on usage from command line, corrected sense of topicsearch filter (Item2120, Item2121), renamed parameters (old ones are still valid), corrected handling of empty web refs (Item2128), deprecated nopublish html-style tag in favour of PublishWebPlugin-compatible style (though with richer semantics) (Item2196)
9823	Crawford Currie - added support for hierarchical webs, and inclusion of external images.
9773	Crawford Currie - added tgz and pdf support

| 9725 | Michael Daum - fixed rewriting urls;

>
>

1.5.5	Added support for new internal api - no user changes
1.5.4	Added UI for FTP. Added .spec file. Fixed Item3515 and Item2725
1.5.3	Michael Daum - create a new wiki object for every topic, don't reuse the current one (Item3139)
1.5.2	Correction to the correction for anchors.
1.5.1	Correction to support anchors in URLs properly
1.5.0	Martin Cleaver - changes to allow generation of viewprint and viewxxx when specified by TEMPLATE; multiple INSTANCE (dev/test/prod); (Item2269)
1.4.3	Bugfix Item2216
1.4.2	Crawford Currie - fixed problem where it was failing to remove <base> tags completely (Item2200)
1.4.1	Crawford Currie - added doc on usage from command line, corrected sense of topicsearch filter (Item2120, Item2121), renamed parameters (old ones are still valid), corrected handling of empty web refs (Item2128), deprecated nopublish html-style tag in favour of PublishWebPlugin-compatible style (though with richer semantics) (Item2196)
1.4.0	Crawford Currie - added support for hierarchical webs, and inclusion of external images.
1.3.9	Crawford Currie - added tgz and pdf support

| 1.3.8 | Michael Daum - fixed rewriting urls;

fixed nested resources issue; creating a new prefs object for each topic |

Changed:

<
<

9713	Corrected form action so it uses up the right web preferences

| 9695 | Michael Daum - recursively archive resources imported by css files;

>
>

1.3.7

Corrected form action so it uses up the right web preferences

| 1.3.6 | Michael Daum - recursively archive resources imported by css files;

fixed several html errors in the PublishPlugin and PublishWeb topics; removed hardcoded reference to print.pattern |

Changed:

<
<

8959	TWiki-4 version. Also supports publishing to a file area, making TWiki easier to use as a CMS (see also Foswiki:Extensions/PublishWebPlugin, which does almost the same thing )
6276	Item196 - bugfix for HTTP_HOST, as described in the Dev topic for the contrib
5566	Changed interface to support wildcards, and lightened the plugin by replacing a lot of files with simpler ways of doing things.
5499	Added Compress::Zlib dependency, as requested by Brad Taylor
27 Apr 2005	1.301 Crawford Currie - fixed minor issues highlighted by Bruce Dillahunty and Scott Claridge
11 Apr 2005	1.3 Crawford Currie - reworked the interface and code to work better
13 October 2004	1.200 Crawford Currie - Cairo compatible
7 Jan 2003	1.1 Initial version

>
>

1.3.5	TWiki-4 version. Also supports publishing to a file area, making TWiki easier to use as a CMS (see also Foswiki:Extensions/PublishWebPlugin, which does almost the same thing )
1.3.4	Item196 - bugfix for HTTP_HOST, as described in the Dev topic for the contrib
1.3.3	Changed interface to support wildcards, and lightened the plugin by replacing a lot of files with simpler ways of doing things.
1.3.2	Added Compress::Zlib dependency, as requested by Brad Taylor
1.3.1 (27 Apr 2005)	Crawford Currie - fixed minor issues highlighted by Bruce Dillahunty and Scott Claridge
1.3.0 (11 Apr 2005)	Crawford Currie - reworked the interface and code to work better
1.2.0 (13 October 2004)	Crawford Currie - Cairo compatible
1.1.0 (7 Jan 2003)	Initial version

Home:	http://foswiki.org/Extensions/PublishPlugin
Support:	http://foswiki.org/Support/PublishPlugin

Line: 622 to 718

GNU General Public License for more details, published at http://www.gnu.org/copyleft/gpl.html

Changed:

<
<

META FILEATTACHMENT	attachment="publish.gif" attr="" comment="Logo" date="1267038713" name="publish.gif" size="54531" user="BaseUserMapping_333" version="1"
META FILEATTACHMENT	attachment="wikiringlogo20x20.png" attr="" comment="" date="1267038713" name="wikiringlogo20x20.png" size="1343" user="BaseUserMapping_333" version="1"

>
>

META FILEATTACHMENT	attachment="publish.gif" attr="" comment="Logo" date="1301337166" name="publish.gif" size="54531" user="BaseUserMapping_333" version="1"
META FILEATTACHMENT	attachment="wikiringlogo20x20.png" attr="" comment="" date="1301337166" name="wikiringlogo20x20.png" size="1343" user="BaseUserMapping_333" version="1"

Revision 3

12 Oct 2010 - Main.AdminUser

Line: 1 to 1
	PublishPlugin Generates a static view of a web, as HTML files on disc, or as a `PDF`, or as a `zip` or `tgz` archive file, or by uploading directly to an FTP server.

Revision 2

12 Oct 2010 - Main.AdminUser

Line: 1 to 1

PublishPlugin

Generates a static view of a web, as HTML files on disc, or as a PDF, or as a zip or tgz archive file, or by uploading directly to an FTP server.

Line: 621 to 622

GNU General Public License for more details, published at http://www.gnu.org/copyleft/gpl.html

Changed:

<
<

META FILEATTACHMENT	attr="h" comment="Logo" name="publish.gif"
META FILEATTACHMENT	attr="h" comment="" name="wikiringlogo20x20.png" version="1"

>
>

META FILEATTACHMENT	attachment="publish.gif" attr="" comment="Logo" date="1267038713" name="publish.gif" size="54531" user="BaseUserMapping_333" version="1"
META FILEATTACHMENT	attachment="wikiringlogo20x20.png" attr="" comment="" date="1267038713" name="wikiringlogo20x20.png" size="1343" user="BaseUserMapping_333" version="1"

View topic | History: r7 < r6 < r5 < r4 | More topic actions...

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