The WikiPlugin generates a Usemod Wiki file that has the same look and feel as the Maven-generated website.

A Wiki is a web page that anyone can modify as wanted. The main interest of a Wiki is simplicity. One doesn't need to be a programmer, or even a webmaster, to write wiki files. The only things to keep in mind are the UseMod:TextFormattingRules, that are used to edit the pages. This allows informations to be shared and updated at light's speed, while being a very entertaining experience. All you need is a web browser ! ;-)

Goals proposal

  • wiki:file generates the file (implemented)
  • wiki:deploy deploys the generated file to a server (implemented)
  • wiki:backup backs up the data to the local drive (implemented)

Properties

  • Proper plugin properties:
    • maven.wiki.server = ${pom.siteAddress} : The server on which the wiki will be installed
    • maven.wiki.dir = ${pom.siteDirectory} : The directory on the server where the wiki will be installed
    • maven.wiki.username = ${maven.username} : The user name that has the appropriate rights on the script
    • maven.wiki.site = ${pom.url} : The address of the generated website, for links and css
  • Wiki own properties:
    • maven.wiki.DataDir = /home/wiki : Main wiki directory
    • maven.wiki.UseConfig = 0 : 1 = use config file, 0 = do not look for config
    • maven.wiki.CookieName = ${pom.name} : Name for this wiki (for multi-wiki sites)
    • maven.wiki.SiteName = ${pom.name} Wiki : Name of site (used for titles)
    • maven.wiki.HomePage = HomePage : Home page (change space to _)
    • maven.wiki.RCName = RecentChanges : Name of changes page (change space to _)
    • maven.wiki.LogoUrl = ${pom.url}/${pom.organization.logo} : URL for site logo ("" for no logo)
    • maven.wiki.ENVPATH = /usr/bin/ : Path used to find "diff"
    • maven.wiki.ScriptTZ = : Local time zone ("" means do not print)
    • maven.wiki.RcDefault = 30 : Default number of RecentChanges days
    • maven.wiki.RcDays = 1 3 7 30 90 : Days for links on RecentChanges
    • maven.wiki.KeepDays = 14 : Days to keep old revisions
    • maven.wiki.SiteBase = : Full URL for <BASE> header
    • maven.wiki.FullUrl = : Set if the auto-detected URL is wrong
    • maven.wiki.RedirType = 1 : 1 = CGI.pm, 2 = script, 3 = no redirect
    • maven.wiki.AdminPass = : Set to non-blank to enable password(s)
    • maven.wiki.EditPass = : Like AdminPass, but for editing only
    • maven.wiki.StyleSheet = maven.css : URL for CSS stylesheet (like "/wiki.css")
    • maven.wiki.NotFoundPg = : Page for not-found links ("" for blank pg)
    • maven.wiki.EmailFrom = Wiki : Text for "From: " field of email notes.
    • maven.wiki.SendMail = /usr/sbin/sendmail : Full path to sendmail executable
    • maven.wiki.FooterNote = © ${pom.inceptionYear} - ${pom.organization.name} : HTML for bottom of every page
    • maven.wiki.EditNote = : HTML notice above buttons on edit page
    • maven.wiki.MaxPost = 1024 * 210 : Maximum 210K posts (about 200K for pages)
    • maven.wiki.NewText = : New page text ("" for default message)
    • maven.wiki.HttpCharset = ISO-8859-1 : Charset for pages, like "iso-8859-2"
    • maven.wiki.UserGotoBar = : HTML added to end of goto bar
  • Major Wiki options:
    • maven.wiki.UseSubpage = 1 : 1 = use subpages, 0 = do not use subpages
    • maven.wiki.UseCache = 0 : 1 = cache HTML pages, 0 = generate every page
    • maven.wiki.EditAllowed = 1 : 1 = editing allowed, 0 = read-only
    • maven.wiki.RawHtml = 0 : 1 = allow <HTML> tag, 0 = no raw HTML in pages
    • maven.wiki.HtmlTags = 0 : 1 = "unsafe" HTML tags, 0 = only minimal tags
    • maven.wiki.UseDiff = 1 : 1 = use diff features, 0 = do not use diff
    • maven.wiki.FreeLinks = 1 : 1 = use [[word]] links, 0 = LinkPattern only
    • maven.wiki.WikiLinks = 1 : 1 = use LinkPattern, 0 = use [[word]] only
    • maven.wiki.AdminDelete = 1 : 1 = Admin only page, 0 = Editor can delete pages
    • maven.wiki.RunCGI = 1 : 1 = Run script as CGI, 0 = Load but do not run
    • maven.wiki.EmailNotify = 0 : 1 = use email notices, 0 = no email on changes
    • maven.wiki.EmbedWiki = 0 : 1 = no headers/footers, 0 = normal wiki pages
  • Minor Wiki options:
    • maven.wiki.LogoLeft = 1 : 1 = logo on left, 0 = logo on right
    • maven.wiki.RecentTop = 1 : 1 = recent on top, 0 = recent on bottom
    • maven.wiki.UseDiffLog = 1 : 1 = save diffs to log, 0 = do not save diffs
    • maven.wiki.KeepMajor = 1 : 1 = keep major rev, 0 = expire all revisions
    • maven.wiki.KeepAuthor = 1 : 1 = keep author rev, 0 = expire all revisions
    • maven.wiki.ShowEdits = 0 : 1 = show minor edits, 0 = hide edits by default
    • maven.wiki.HtmlLinks = 0 : 1 = allow A HREF links, 0 = no raw HTML links
    • maven.wiki.SimpleLinks = 0 : 1 = only letters, 0 = allow _ and numbers
    • maven.wiki.NonEnglish = 0 : 1 = extra link chars, 0 = only A-Za-z chars
    • maven.wiki.ThinLine = 0 : 1 = fancy <hr> tags, 0 = classic wiki <hr>
    • maven.wiki.BracketText = 1 : 1 = allow [URL text], 0 = no link descriptions
    • maven.wiki.UseAmPm = 1 : 1 = use am/pm in times, 0 = use 24-hour times
    • maven.wiki.UseIndex = 0 : 1 = use index file, 0 = slow/reliable method
    • maven.wiki.UseHeadings = 1 : 1 = allow = h1 text =, 0 = no header formatting
    • maven.wiki.NetworkFile = 1 : 1 = allow remote file:, 0 = no file:// links
    • maven.wiki.BracketWiki = 0 : 1 = [WikiLnk txt] link, 0 = no local descriptions
    • maven.wiki.UseLookup = 1 : 1 = lookup host names, 0 = skip lookup (IP only)
    • maven.wiki.FreeUpper = 1 : 1 = force upper case, 0 = do not force case
    • maven.wiki.FastGlob = 1 : 1 = new faster code, 0 = old compatible code

Features requests

  • The generated file should be localized
  • We should be able to choose and install WikiPlugins? in the same time (for instance, UseMod:WikiPatches/TableSyntaxCommonMarkup that allows to build tables).
  • Try and implement a SmileysWikiPlugin? (I love smileys !) that transforms :-) :-( ;-) :-D etc. to images, like in Mozilla Mail. See TWiki:Plugins/SmiliesPlugin
  • Choose between several Wikis (Usemod, TWiki, etc.)
  • A wiki2xdoc transformation goal - this would allow one to create documentation as a wikipage and use this as the basis for "static" documentation that you can deliver as part of a specific version of a Maven managed project. I'm sure there are some things that need some more thinking like what to do about the WikiLinks?. But anyway I think it would be a nice addition! --JornH 
 Would be cool ! --StephaneMor
  • A wiki changelog page, so that we can visualize from the "normal" website what has changed in the wiki. There could also be file activity and developer activity reports

-- StephaneMor

[Homepage of this plugin] | PluginMaturity?: MavenPlugins
Edit text of this page | View other revisions
Last Edited 13 September 2002 3:25 pm (diff)
Search:
© 2002 - SourceForge