[{TableOfContents }]
%%commentbox
__Versions :__\\
-----
[Latest|FortuneCookiePlugin#Latest] (most up to date )\\
[Archive|FortuneCookiePlugin#Archive] (previous versions)
%%

!! Description
This plugin will return a random single line from any designated Wiki page on each call. Thus each line of this page becomes a "[fortune|Wikipedia:Fortune_cookie]".


!! Download
Please choose your plugin version:

! Latest
This is the most up to date version of the plugin.

25-Sep-2008: [FortuneCookiePlugin_v2.6.4.jar] package. [FortuneCookie.java] source.\\
''(Tested with JSPWiki 2.6.4 and Sun JDK 1.6.0)''

Here are the changes:
* Changed the plugin package and classname, it is now {{{de.ldj.jspwiki.plugin.FortuneCookie}}}
* The fortunes will be cached and only reloaded if the fortunes page becomes modified. A count of fortunes as first line is no longer required/used.
* Removed the usage of deprecated API. ''(I tested with JSPWiki v2.6.4 & JDK 1.6.0, but it should also work with later versions.)''
* Overall source cleanup. ''(see [FortuneCookie.java])''

! Archive
Here you can find more recent versions of the plugin.

18-Mar-2005: [FortuneCookiePluginv2.0.52.jar] package.\\
--[MBarcia]: ''(This plugin was not working for the 2.0.52 stable version. Also attached to this page is the JAR for this version. HTH)''

05-Oct-2004: [FortuneCookies.jar] package. [FortuneCookiePlugin.java] source.\\
-- [Bradford Holcombe]: ''(I have added code to remove list wiki markup from each line. This allows the [original page|http://colbadhombre.net/SecularWiki/Wiki.jsp?page=Sayings] to use the wiki list syntax, so the fortune line looks better when rendered in its own page. Thanks to [suggestions|EmbeddingJSPWiki] from Janne, I have added a call to the wiki tranlation engine so that each line (minus its original list markup) renders any wiki markup in the returned fortune. The new source is above, and the JAR reflects these changes.)''


!! Usage
In order to use this plugin you need to:
# [Download|FortuneCookiePlugin#Download] the plugin JAR
# Add the JAR to your JSPWiki classpath. (consult your ServletContainer manual how to do this)
# Prepare a WikiPage with fortunes. (see [Fortune Format|FortuneCookiePlugin#Fortune Format])
# Call the plugin at any WikiPage (except the one with the fortunes, this would cause an enless recursion)\\ Depending on the version you choose, the call must be different:
** 25-Sep-2008 [FortuneCookiePlugin_v2.6.4.jar]: {{{[{de.ldj.jspwiki.plugin.FortuneCookie page='FortuneCookies'}]}}}
** 18-Mar-2005 [FortuneCookiePluginv2.0.52.jar]: {{{[{net.colbadhombre.JSPWiki.plugins.FortuneCookiePlugin page='Sayings'}]}}}
** 05-Oct-2004 [FortuneCookies.jar]: {{{[{com.bradfordholcombe.JSPWiki.plugins.FortuneCookiePlugin page='Sayings'}]}}}

The plugin requires the parameter '{{page}}' to work. The value of {{page}} must be the name of an existing WikiPage. This page will be used as fortune page and must not contain a call to the FortuneCookiePlugin, because it might cause an endless recursion. Please find the format specification for the fortune page below.

%%warning Each caller must use the same WikiPage as fortune page!\\
The plugin behaviour is undefined if there are calls to different fortune pages.%%


!! Fortune Format
The fortune cookie plugin uses one WikiPage as fortune source. Each line on this page will become considered a fortune.

The following formatting rules apply to the fortune page:
* The fortune lines must be seperated by new-lines. Forced line breaks within the lines ({{{\\}}}) are not used as fortune delimeter. Thus it is possible to write multi-line fortunes.
* The fortunes can be written as bulleted list (*), numbered list (#), with forced line breaks ('{{{\\}}}' followed by new-line) or as paragraphs (empty lines between each fortune). Even a mix is possible.
* '*' or '#' at the begining of fortune lines will be removed before rendering the fortunes.
* Fortunes with a forced line break at the end of their lines ('{{{\\}}}' followed by whitespace and a new-line) will be rendered without the trailing '{{{\\}}}'.

* Regular Wiki markup can be used to style the fortunes.
* Lines starting with '//' are considered as comment and will be ignored.

----
One last hint: If you want to emphasize your fortune cookies, so they look cool try to put the plugin inside a ''weblogcomments'' style block.
{{{
%%weblogcomments
[{de.ldj.jspwiki.plugin.FortuneCookie page='FortuneCookies'}]
%%
}}}

--[Maik Scheibler], 25-Sep-2008 04:52

----
ContributedPlugins