You are here: Foswiki>LabstaffWeb Web>RpiTwiki>WikiWebPublish (19 Nov 2009, armstj2@LAB.CS.RPI.EDU)Edit Attach

Publishing a static wiki-web

Pages in a TWiki web are rendered dynamically when requested. When pages grow large and cannot be broken down into a hierarchy web of pages rendering them can take time. Publishing a web as a set of static pages can greatly improve access times in this case. When requested a scan can be made of all pages in a web and their contents rendered statically into a dedicated directory for browsing.

Contact labstaff@cs.rpi.edu if you would like to take advantage of this feature.

The easiest way to publish a web is from this topic, by filling in the following form.

The output is generated in a directory designated during installation. The progress messages printed during documentation generation tell you exactly where the output is, and you can use the publishers control interface to manage your published output.

Publishing is a controlled process; before you can publish, you have to have VIEW access to the topics you want to publish, and CHANGE access to the publishing history topic.

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

Choose what to publish

Web to publish web

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

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

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

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.
The currently enabled plugins are: TWikiCompatibilityPlugin, SpreadSheetPlugin, SlideShowPlugin, AutoViewTemplatePlugin, CommentPlugin, CompareRevisionsAddonPlugin, ConfigurePlugin, EditRowPlugin, HistoryPlugin, HomePagePlugin, InterwikiPlugin, JQueryPlugin, MailerContribPlugin, NatEditPlugin, PreferencesPlugin, RenderListPlugin, SmiliesPlugin, SubscribePlugin, TablePlugin, TinyMCEPlugin, TwistyPlugin, UpdatesPlugin, WysiwygPlugin enableplugins

Output options

Select skin for published HTML The skin provides the template for how topics are published. See TWikiSkins 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 URL. skin

Output format The output will be generated on the server, in the directory pointed to by the {PublishContrib}{Dir} configuration setting. You can manage the contents of this directory from the browser using the publishers control interface to the publish CGI script.
X The rendered data can get pretty big, and the process itself puts a heavy load on the server, especially when using compression on large webs. format

Publishing history topic This is where the history of your publishing is stored. Each time you publish, this topic is re-written with the log of the publishing process. You have to have "change" access to this topic. history

FTP options

FTP options are only relevant if Output format is ftp

The FTP output format generates a sitemap.xml, and can also generate default.htm, index.html and google site verification files.

The FTP output generator was written by TWiki:Main.SvenDowideit.

Destination FTP server	Set to blank to proof the output prior to uploading to your site.	`destinationftpserver`
Path to upload to on server		`destinationftppath`
FTP username		`destinationftpusername`
FTP Password		`destinationftppassword`
Google file	generates the `HTML verification file` needed to verify your site claim. see Google webmaster tools	`googlefile`
Default topic:	Name of topic to used to generate default.htm, index.html	`defaultpage`
Relative URL used in sitemap	the base URL that your published TWiki topics will reside at (if you are publishing to the root of your site, `/` is correct) see Google webmaster tools	`relativeurl`
Fast publish	Speed up the ftp publishing by only uploading modified files.	`fastupload`

Other output generator options

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

-- JoeyArmstrong 2009 Nov 19

Topic revision: r1 - 19 Nov 2009, armstj2@LAB.CS.RPI.EDU

LabstaffWeb

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