r2 - 08 Nov 2006 - 09:51:56 - JohnDeStefanoYou are here: TWiki >  Main Web > PublishContrib
This plugin generates a static view of a web as HTML files for publishing, or as archives or PDF files.


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

The output is generated in a default publishing directory. The progress messages printed during documentation generation tell you exactly where the output is.

DescriptionValueParameter Name
Web to publish web
Comma-separated list of wildcard patterns that match the names of topics to include inclusions
Comma-separated list of wildcard patterns that match the names of topics to exclude exclusions
A regular expression that will cause a topic to be excluded if the RE matches the topic content filter
Select skin for published HTML: skin
Output format :
For normal page publishing, use the default selection file.
Extra options : Some output generators support extra options (e.g. PDF; you can add htmldoc command-line parameters here e.g --linkstyle underline)

Wildcard Patterns

Wildcard patterns are well known to people who are used to command lines on computers, but may be unfamiliar to the Windows generation. A wildcard is a special string that you can put into a filename so that it matches a whole range of files:
String What it does Example What the example matches
* Matches any string, including an empty string. *Cheese* Every topic with "Cheese" somewhere in the name (but not "cheese")
? Matches any single character. Example1? Example10 and Example 1X but not example1
[...] Matches any one of the enclosed characters. A pair of characters separated by a hyphen denotes a range expression; any character that sorts between those two characters, inclusive, using the current locale's collating sequence and character set, is matched. If the first character following the [ is a ^ then any character not enclosed is matched. A - may be matched by including it as the first or last character in the set. A ] may be matched by including it as the first character in the set.
Within [ and ], character classes can be specified using the syntax [:class:], where class is one of the following classes defined in the POSIX.2 standard: alnum, alpha, ascii, blank, cntrl, digit, graph, lower, print, punct, space, upper, word, xdigit. A character class matches any character belonging to that class. The word character class matches letters, digits, and the character _.
B[aeiou]g Bag, Bog, Big, Beg, Bug

Regular Expressions

A perl regular expression. You can use a simple string here, which will be matched exactly, or you can read up on perl regular expressions on the web.

About This Site

Please note that this site is a content mirror of the BNL US ATLAS TWiki. To edit the content of this page, click the Edit this page button at the top of the page and log in with your US ATLAS computing account name and password.


Powered by TWiki
This site is powered by the TWiki collaboration platformCopyright © by the contributing authors. All material on this collaboration platform is the property of the contributing authors.
Ideas, requests, problems regarding TWiki? Send feedback