All Packages from org.devtools.wiki.test.* to org.devtools.wiki.util.*

Home >> All >> org >> devtools >> [ wiki Javadoc ]

•

• org.devtools.wiki: Javadoc index of package org.devtools.wiki.

Package Samples:

• org.devtools.wiki.test
• org.devtools.wiki.util
• org.devtools.wiki.translators

Classes:

• CachingTranslatorManager: Translates a WebContent into HTML by applying a number of Translators. Each Translator can insert, delete, and replace text in the original content. The changes are gathered together, merged, and applied to the document at the end of the process. (This is done so that each Translator module works with the real, original document and does not accidentally interpret partial changes to the document to be original content.) In addition, TranslatorManager hides any literal areas from the Translators, so that it cannot be considered or changed. (A literal area is any text enclosed in the LITERAL symbols). ...
• WikiTranslatorManager: Translates a WebContent into HTML by applying a number of Translators. Each Translator can insert, delete, and replace text in the original content. The changes are gathered together, merged, and applied to the document at the end of the process. (This is done so that each Translator module works with the real, original document and does not accidentally interpret partial changes to the document to be original content.) In addition, TranslatorManager hides any literal areas from the Translators, so that it cannot be considered or changed. (A literal area is any text enclosed in the LITERAL symbols). ...
• CVSFilePersister: A file-based persistence mechanism that implements the Persister interface. Each file action (save, delete) is committed to a source control system. This implementation assumes that a page's URL can be constructed by appending the page title (and therefore disk file name) to the base URL. This object expects to see the option CVSFilePersister.RootDir in the config file, and takes it to mean the directory which it should scan to acquire the files to be served as WebContent. Properties for objects are written to a file called XXX.properties for each resource XXX. Accordingly, CVSFilePersister expects ...
• FilePersister: A file-based persistence mechanism that implements the Persister interface. This implementation assumes that a page's URL can be constructed by appending the page title (and therefore disk file name) to the base URL. This object expects to see the option FilePersister.RootDir in the config file, and takes it to mean the directory which it should scan to acquire the files to be served as WebContent. Properties for objects are written to a file called XXX.properties for each resource XXX. Accordingly, FilePersister expects that all files with a .properties extension are properties files that it created, ...
• WikiServices: Provides services and config options to the translators and factory-izes the various Wiki components. Note that some objects may choose to be singletons, so multiple calls to getWhatever() may return the same object. Of course, if the returned object is a singleton, one might expect it to do a good job of handling potentially synchronous conditions. WikiServices expects a sole initial argument from the ServletConfig, which should be of the form "ConfigFile = /location/of/properties/file.properties". This file should contain one or more of the following properties:
• DevtoolsLNFTranslator: Inserts the wondrous devtools.org look and feel header and footer. Expects the following parameters to be available from the TranslatorServices: Wiki.FrontPage: The name of the page that is the entry point to the site. Wiki.EditPage: The name of the page that allows the user to edit pages. Wiki.DeletorPage: The name of the page that will delete pages.
• WidgetTranslator: An abstract base class for widget translators. Searches for text of the form [widget param=value:value param=value...] and replaces it with whatever text is returned from its handleWidget method. Subclasses should override the handleWidget method to do something useful with the widget. This widget also obtains a reference to the services object so that your subclass doesn't have to.
• StockLNFTranslator: Inserts a stock look and feel header and footer. Expects the following parameters to be available from the TranslatorServices: Wiki.FrontPage: The name of the page that is the entry point to the site. Wiki.EditPage: The name of the page that allows the user to edit pages. Wiki.DeletorPage: The name of the page that will delete pages.
• PropertyListTranslator: Bolds all of the '''-enclosed strings in the document, Emphasizes all of the ''-enclosed strings in the document, and both bolds and emphasizes all of the '''''-enclosed strings in the document. This translator will not work with any other translators that process single quotes. To get the correct behavior, implement a translator which combines all single-quote processing into one.
• QuoteTranslator: Bolds all of the '''-enclosed strings in the document, Emphasizes all of the ''-enclosed strings in the document, and both bolds and emphasizes all of the '''''-enclosed strings in the document. This translator will not work with any other translators that process single quotes. To get the correct behavior, implement a translator which combines all single-quote processing into one.
• EditTranslator: Inserts a page editor widget, which edits the contents of the page named by the page query item. FIXME: Should be able to take a page to edit in the tag itself, like "[editor page=BlahPage]". Expects the following parameters to be available from the TranslatorServices: Wiki.PutterPage: The name of the page that can write content to disk.
• ChangelogEntryTranslator: Appends fields from an HTML form to the content of a page. The fields to append should be specified in a :-delimited list in the fieldkeys parameter. The page and type parameters specify which page will be appended. Each form parameter will be written as |name|=|value|\n to the content of the page.
• FormEntryTranslator: Appends fields from an HTML form to the content of a page. The fields to append should be specified in a :-delimited list in the fieldkeys parameter. The page and type parameters specify which page will be appended. Each form parameter will be written as |name|=|value|\n to the content of the page.
• OnsiteLinkTranslator: Picks up all of the mixed-case words in the page as on-site links. If the mixed-case word is not a page of the current type, searches other types. If it is not a page of any type, inserts an editme (?) after the name. Only considers pages that have a type in the list OnsiteLinkTypes.
• TempWebContent: A temporary WebContent object. There is no hookup to a persistence layer, so any changes made will not be saved. This is useful for performing transient changes that result in a WebContent object, without the overhead of hitting a disk or other Persister type.
• DeleteTranslator: Creates a Delete widget, which removes the persistent version of this page from storage. Ever after, it will seem to be a new page. FIXME: Should be able to take a page to delete in the tag itself, like "[Delete page=BlahPage content="Hi you bastard."]".
• BoldTranslator: Bolds all of the '''-enclosed strings in the document. This translator will not work with any other translators that process single quotes. To get the correct behavior, implement a translator which combines all single-quote processing into one.
• ContentTranslator: Writes the untranslated content of the page passed by the page and type HTTP GET parameters in place of the widget. FIXME: Should be able to take a page to edit in the tag itself, like "[putter page=BlahPage content="Hi you bastard."]".
• ListTranslator: Converts *-delimited lists into unordered HTML lists. Any line that begins with a * is a list item. Each space in front of the * is an additional indent level. Each list item ends at the closer of (a) the next star or (b) the next blank line.
• ContentSearcher: Performs search services across wiki pages. Some naming conventions: A search is exact if it the text contains the given string, including case. A search is complete if the text is the same as the given string, including case.
• ResolvingPutterTranslator: Creates a putter widget, which translates and stores the page and content given in the properties. FIXME: Should be able to take a page to edit in the tag itself, like "[putter page=BlahPage content="Hi you bastard."]".
• RetranslateTranslator: Creates a putter widget, which translates and stores the page and content given in the properties. FIXME: Should be able to take a page to edit in the tag itself, like "[putter page=BlahPage content="Hi you bastard."]".
• ParamEchoTranslator: Writes the value of the parameter given to paramkey out. If decode=true is specified, then it assumes that the variable is encoded in hex, and uses StringTools.decodeString to parse it before returning it.
• UsageTranslator: Inserts a site usage widget, which edits the contents of the page named by the page query item. FIXME: Should be able to take a page to edit in the tag itself, like "[usage type=whatever]".
• FileWebContent: Implementation of a WebContent that is designed to work with the FilePersister. This particular implementation dumbly passes all requests through to FilePerister.

Home | Contact Us | Privacy Policy | Terms of Service