| At line 1 added 137 lines |
| !!!Einleitung |
| Die Seite [http://www.jspwiki.org/wiki/JSPWikiCorePlugins] enthält eine Liste der Standard-Plugins von JSPWiki. |
|
| ---- |
|
| Since v1.6.3 you can now define your own plugins. These are just |
| simply Java classes that implement the |
| ''WikiPlugin'' interface and can be found from |
| somewhere in your class path. The plugins work so that when you write |
| a special code on the Wiki page, the plugins are invoked and their |
| output is inserted into the page, verbatim. |
|
| The form is: |
|
| [[{INSERT <plugin class> WHERE <param1=value1>,<param2=value2>,...}] |
|
| You can also use a shortcut: instead of using {{[[{INSERT RecentChangesPlugin}} you can also use {{[[{INSERT RecentChangesPlugin}]}}. This works only with the plugins that come with JSPWiki, though. |
|
| If a parameter contains spaces, you can use single quotes (') around the parameter. Like this: |
|
| [[{INSERT CurrentTimePlugin format='dd MM yyyy'}] |
|
| Here are some sample plugins included in the archive: |
|
| !!!RecentChangesPlugin |
|
| Inserts the latest changes in order. |
|
| !!Parameters: |
| * __since__=''n'' : show changes from the last n days. |
| * __format__=''(full|compact)'' : if "full", then display a long |
| version with all possible info. If "compact", then be as compact as possible. |
|
| !!Example: |
| {{{ |
| [{INSERT RecentChangesPlugin since=5, format=compact}] |
| }}} |
|
| Inserts the changes from the past 5 days in a compact format. You |
| might use this to make an automatical list of changes to the [LeftMenu], or [LeftMenuFooter], for example. |
|
| |
| !!!UnusedPagesPlugin |
|
| Lists all pages that are not currently referred to by any other page, thus meaning they are inaccessible through any other means. |
|
| !!Parameters |
|
| * __maxwidth__=''n'' : Limits the length of the generated links to at most ''n'' characters. This should used to keep the [LeftMenu] or [LeftMenuFooter] at a manageable width. Default is to not limit the length at all. |
|
|
| !!Example: |
|
| See [UnusedPages]. |
|
| !!!UndefinedPagesPlugin |
|
| Lists all pages that are referred to, but not yet created. |
|
| !!Parameters |
|
| * __maxwidth__=''n'' : Limits the length of the generated links to at most ''n'' characters. This should used to keep the [LeftMenu] or [LeftMenuFooter] at a manageable width. Default is to not limit the length at all. |
|
| !!Example: |
|
| See [UndefinedPages]. |
|
| !!!ReferringPagesPlugin |
|
| Finds and lists all pages that refer to the current page. |
|
| !!Parameters |
|
| * __max__=''n'' : How many pages to list. Default is 10. Some pages might create very long lists, so it's a good idea to limit the list size. |
| * __maxwidth__=''n'' : Limits the length of the generated links to at most ''n'' characters. This should used to keep the [LeftMenu] or [LeftMenuFooter] at a manageable width. Default is to not limit the length at all. |
|
| !!Example |
|
| See [LeftMenuFooter]. |
|
| !!!CurrentTimePlugin |
|
| Just displays the current server time. |
|
| !!Parameters |
|
| * __format__=''format string'' : How the date and time should be formatted. If you omit this, a default format will be used. The following characters are available to you: |
|
| {{{ |
| Symbol Meaning Presentation Example |
| ------ ------- ------------ ------- |
| G era designator (Text) AD |
| y year (Number) 1996 |
| M month in year (Text & Number) July & 07 |
| d day in month (Number) 10 |
| h hour in am/pm (1~12) (Number) 12 |
| H hour in day (0~23) (Number) 0 |
| m minute in hour (Number) 30 |
| s second in minute (Number) 55 |
| S millisecond (Number) 978 |
| E day in week (Text) Tuesday |
| D day in year (Number) 189 |
| F day of week in month (Number) 2 (2nd Wed in July) |
| w week in year (Number) 27 |
| W week in month (Number) 2 |
| a am/pm marker (Text) PM |
| k hour in day (1~24) (Number) 24 |
| K hour in am/pm (0~11) (Number) 0 |
| z time zone (Text) Pacific Standard Time |
| \' escape for text (Delimiter) |
| \'' single quote (Literal) ' |
| }}} |
|
| For example, two 'y':s give you the year using two digits. Four 'y':s give you the year in four digits. Three 'M':s give you the month in letters, whereas two 'M':s give just the month number. |
|
| (Yes, these are exactly the Java [SimpleDateFormat|http://java.sun.com/j2se/1.3/docs/api/java/text/SimpleDateFormat.html] arguments. Sorry for copying them in.) |
|
| !!Example |
|
| Using [[{INSERT CurrentTimePlugin format='yyyy.MM.dd G \'at\' hh:mm:ss z'}] would give you: |
|
| [{INSERT CurrentTimePlugin format='yyyy.MM.dd G \'at\' hh:mm:ss z'}] |
|
| !!!Alias |
| Gelegentlich soll eine Seite tatsächlich existieren, aber sie soll auf den Inhalt einer anderen Seite verweisen. |
| Zum Beispiel wenn die Seite trotz wechselnden Zielseiten als Bookmark oder Einstiegs-Seite verwendet werden soll. |
|
| Dafür kann ein ''Alias'' auf der Seite eingerichtet werden. Das Wiki wird dann die erstellte Seite im Index aufführen aber stattdessen die im Alias definierte Seite ausliefern. |
|
| !!Example |
| {{{ |
| [{SET alias='PageAlias'}] |
| }}} |
|
| !!!Forms |
| Aktuell noch nicht im OKIT-Wiki verwendet, aber prinzipiell geeignet für die Aufnahme von Daten und Ereignissen. |
| Siehe [https://jspwiki-wiki.apache.org/Wiki.jsp?page=WikiFormsPlugin] |