From: Torbjorn T. <et...@us...> - 2005-11-20 18:42:46
|
Update of /cvsroot/jungerl/jungerl/lib/yfront/doc In directory sc8-pr-cvs1.sourceforge.net:/tmp/cvs-serv5043/doc Modified Files: edoc-info modules-frame.html wblog.html Added Files: yfront.html Log Message: Added language adaption capability. Index: edoc-info =================================================================== RCS file: /cvsroot/jungerl/jungerl/lib/yfront/doc/edoc-info,v retrieving revision 1.1 retrieving revision 1.2 diff -u -d -r1.1 -r1.2 --- edoc-info 14 Nov 2005 23:09:10 -0000 1.1 +++ edoc-info 20 Nov 2005 18:42:38 -0000 1.2 @@ -1,3 +1,3 @@ {application,yfront}. {packages,[]}. -{modules,[wblog,wraplog,ymnesia]}. +{modules,[wblog,wraplog,yfront,ymnesia]}. --- NEW FILE: yfront.html --- <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> <html> <head> <title>Module yfront</title> <link rel="stylesheet" type="text/css" href="stylesheet.css"> </head> <body bgcolor="white"> <h1>Module yfront</h1> <b>yfront</b> is a toolbox for building Yaws/Mnesia web apps.<ul><li><a href="#description">Description</a></li><li><a href="#index">Function Index</a></li><li><a href="#functions">Function Details</a></li></ul><p><b>Authors:</b> Torbjörn Törnkvist (<a href="mailto:to...@to..."><tt>to...@to...</tt></a>).</p> <h2><a name="description">Description</a></h2><b>yfront</b> is a toolbox for building Yaws/Mnesia web apps. <h2><a name="index">Function Index</a></h2> <table width="100%" border="1"><tr><td valign="top"><a href="#auth_digest_redirect-0">auth_digest_redirect/0</a></td><td/></tr> <tr><td valign="top"><a href="#auth_redirect-0">auth_redirect/0</a></td><td>Return a 401 Authorization-Required status code, require Basic-Authentication.</td></tr> <tr><td valign="top"><a href="#auth_redirect-1">auth_redirect/1</a></td><td>Works as <a href="#auth_redirect-0"><code>auth_redirect/0</code></a>, specify realm.</td></tr> </table> <h2><a name="functions">Function Details</a></h2> <h3><a name="auth_digest_redirect-0">auth_digest_redirect/0</a></h3> <tt>auth_digest_redirect() -> term() </tt> <h3><a name="auth_redirect-0">auth_redirect/0</a></h3> <tt>auth_redirect() -> term() </tt><p>Return a 401 Authorization-Required status code, require Basic-Authentication.</p> <h3><a name="auth_redirect-1">auth_redirect/1</a></h3> <tt>auth_redirect(Realm) -> term() </tt><p>Works as <a href="#auth_redirect-0"><code>auth_redirect/0</code></a>, specify realm.</p> </body> </html> Index: modules-frame.html =================================================================== RCS file: /cvsroot/jungerl/jungerl/lib/yfront/doc/modules-frame.html,v retrieving revision 1.1 retrieving revision 1.2 diff -u -d -r1.1 -r1.2 --- modules-frame.html 14 Nov 2005 23:09:10 -0000 1.1 +++ modules-frame.html 20 Nov 2005 18:42:38 -0000 1.2 @@ -6,6 +6,6 @@ </head> <body bgcolor="white"> <h2>Modules</h2> -<table width="100%" border="0"><tr><td><a href="wblog.html" target="overviewFrame">wblog</a></td></tr><tr><td><a href="wraplog.html" target="overviewFrame">wraplog</a></td></tr><tr><td><a href="ymnesia.html" target="overviewFrame">ymnesia</a></td></tr></table> +<table width="100%" border="0"><tr><td><a href="wblog.html" target="overviewFrame">wblog</a></td></tr><tr><td><a href="wraplog.html" target="overviewFrame">wraplog</a></td></tr><tr><td><a href="yfront.html" target="overviewFrame">yfront</a></td></tr><tr><td><a href="ymnesia.html" target="overviewFrame">ymnesia</a></td></tr></table> </body> </html> \ No newline at end of file Index: wblog.html =================================================================== RCS file: /cvsroot/jungerl/jungerl/lib/yfront/doc/wblog.html,v retrieving revision 1.1 retrieving revision 1.2 diff -u -d -r1.1 -r1.2 --- wblog.html 14 Nov 2005 23:09:10 -0000 1.1 +++ wblog.html 20 Nov 2005 18:42:38 -0000 1.2 @@ -6,8 +6,8 @@ </head> <body bgcolor="white"> <h1>Module wblog</h1> -<b>wblog</b> is a Yaws appmod plugin that implements a simple (we)blog service.<ul><li><a href="#description">Description</a></li><li><a href="#index">Function Index</a></li><li><a href="#functions">Function Details</a></li></ul><p><b>Authors:</b> Torbjörn Törnkvist (<a href="mailto:to...@to..."><tt>to...@to...</tt></a>).</p> -<h2><a name="description">Description</a></h2><b>wblog</b> is a Yaws appmod plugin that implements a simple (we)blog service. +<b>wblog</b> is a Yaws plugin that implements a simple (we)blog service.<ul><li><a href="#description">Description</a></li><li><a href="#index">Function Index</a></li><li><a href="#functions">Function Details</a></li></ul><p><b>Authors:</b> Torbjörn Törnkvist (<a href="mailto:to...@to..."><tt>to...@to...</tt></a>).</p> +<h2><a name="description">Description</a></h2><b>wblog</b> is a Yaws plugin that implements a simple (we)blog service. With <b>wblog</b>, it is possible to add blog entries as well as list- and traverse the entries. Entries are stored in a Mnesia table that is created once with the <a href="#setup-0"><code>setup/0</code></a> function. New entries are added @@ -40,6 +40,7 @@ <table width="100%" border="1"><tr><td valign="top"><a href="#add_comment-3">add_comment/3</a></td><td>Add a comment to the specified wblog entry.</td></tr> <tr><td valign="top"><a href="#ehtml_entry-1">ehtml_entry/1</a></td><td>Produces an EHTML structure, representing the specified entry.</td></tr> <tr><td valign="top"><a href="#ehtml_entry-2">ehtml_entry/2</a></td><td>Works as <a href="#ehtml_entry-1"><code>ehtml_entry/1</code></a> but also takes a list of options.</td></tr> +<tr><td valign="top"><a href="#ehtml_entry-3">ehtml_entry/3</a></td><td>Works as <a href="#ehtml_entry-2"><code>ehtml_entry/2</code></a> but also takes a list of language translations.</td></tr> <tr><td valign="top"><a href="#ehtml_list-2">ehtml_list/2</a></td><td>Produce a summary list based on a list of wblog entries.</td></tr> <tr><td valign="top"><a href="#entries-1">entries/1</a></td><td>Returns the N last wblog entries.</td></tr> @@ -70,6 +71,32 @@ create a link for creating comments, pointing to CommentsPage appended with the query argument id=ID.</p> +<h3><a name="ehtml_entry-3">ehtml_entry/3</a></h3> +<tt>ehtml_entry(E, Opts, Lang) -> term() +</tt><p>Works as <a href="#ehtml_entry-2"><code>ehtml_entry/2</code></a> but also takes a list of language translations. + By providing language specific Key-Value tuples, it is possible + adapt the wblog to different languages. A tuple consist of a predefined + key and a translated string. The predefined keys are: + <ul> + <li>{prev, String} - string denoting previous entry, + default is <i>"prev"</i></li> + <li>{next, String} - string denoting next entry, + default is <i>"next"</i></li> + <li>{permalink, String} - string denoting current entry, + default is <i>"permalink"</i></li> + <li>{add_comment, String} - string denoting link to add a comment, + default is <i>"add comment"</i></li> + <li>{singular_comment, String} - string denoting the translation, + of the word <i>"comment"</i> which + also is the default value.</li> + <li>{plural_comment, String} - string denoting the translation, + of the word <i>"comments"</i> which + also is the default value.</li> + <li>{by, String} - string denoting the translation, + of the word <i>"by"</i> which + also is the default value.</li> + </ul></p> + <h3><a name="ehtml_list-2">ehtml_list/2</a></h3> <tt>ehtml_list(Ws, Opts) -> term() </tt><p>Produce a summary list |