<html><head><title>Konstrukt::Plugin::blog</title>
<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1" >
<link rel="stylesheet" title="cpan" type="text/css" href="../../cpan.css" media="all" >
</head>
<body class='pod'>
<!--
generated by Pod::Simple::CustomHTML v,
using Pod::Simple::PullParser v2.02,
under Perl v5.008008 at Tue Sep 26 20:07:27 2006 GMT.
If you want to change this HTML document, you probably shouldn't do that
by changing it directly. Instead, see about changing the calling options
to Pod::Simple::CustomHTML, and/or subclassing Pod::Simple::CustomHTML,
then reconverting this document from the Pod source.
When in doubt, email the author of Pod::Simple::CustomHTML for advice.
See 'perldoc Pod::Simple::CustomHTML' for more info.
-->
<!-- start doc -->
<p class="backlinktop"><b><a name="___top" href="../../index.html" accesskey="1" title="All Documents"><<</a></b></p>
<div class='indexgroup'>
<ul class='indexList indexList1'>
<li class='indexItem indexItem1'><a href='#NAME'>NAME</a>
<li class='indexItem indexItem1'><a href='#SYNOPSIS'>SYNOPSIS</a>
<li class='indexItem indexItem1'><a href='#DESCRIPTION'>DESCRIPTION</a>
<li class='indexItem indexItem1'><a href='#CONFIGURATION'>CONFIGURATION</a>
<li class='indexItem indexItem1'><a href='#METHODS'>METHODS</a>
<ul class='indexList indexList2'>
<li class='indexItem indexItem2'><a href='#execute_again'>execute_again</a>
<li class='indexItem indexItem2'><a href='#init'>init</a>
<li class='indexItem indexItem2'><a href='#install'>install</a>
<li class='indexItem indexItem2'><a href='#prepare'>prepare</a>
<li class='indexItem indexItem2'><a href='#execute'>execute</a>
<li class='indexItem indexItem2'><a href='#add_entry_show'>add_entry_show</a>
<li class='indexItem indexItem2'><a href='#add_entry'>add_entry</a>
<li class='indexItem indexItem2'><a href='#edit_entry_show'>edit_entry_show</a>
<li class='indexItem indexItem2'><a href='#edit_entry'>edit_entry</a>
<li class='indexItem indexItem2'><a href='#delete_entry_show'>delete_entry_show</a>
<li class='indexItem indexItem2'><a href='#delete_entry'>delete_entry</a>
<li class='indexItem indexItem2'><a href='#show_entry'>show_entry</a>
<li class='indexItem indexItem2'><a href='#show_entries'>show_entries</a>
<li class='indexItem indexItem2'><a href='#format_and_cache_content'>format_and_cache_content</a>
<li class='indexItem indexItem2'><a href='#delete_cache_content'>delete_cache_content</a>
<li class='indexItem indexItem2'><a href='#add_comment_show'>add_comment_show</a>
<li class='indexItem indexItem2'><a href='#add_comment'>add_comment</a>
<li class='indexItem indexItem2'><a href='#delete_comment'>delete_comment</a>
<li class='indexItem indexItem2'><a href='#filter_show'>filter_show</a>
<li class='indexItem indexItem2'><a href='#export_rss'>export_rss</a>
</ul>
<li class='indexItem indexItem1'><a href='#AUTHOR'>AUTHOR</a>
<li class='indexItem indexItem1'><a href='#SEE_ALSO'>SEE ALSO</a>
</ul>
</div>
<h1><a class='u' href='#___top' title='click to go to top of document'
name="NAME"
>NAME</a></h1>
<p>Konstrukt::Plugin::blog - Konstrukt blogging engine</p>
<h1><a class='u' href='#___top' title='click to go to top of document'
name="SYNOPSIS"
>SYNOPSIS</a></h1>
<pre> <& blog / &></pre>
<h1><a class='u' href='#___top' title='click to go to top of document'
name="DESCRIPTION"
>DESCRIPTION</a></h1>
<p>This Konstrukt Plug-In provides blogging-facilities for your website.</p>
<p>You may simply integrate it by putting</p>
<pre> <& blog / &></pre>
<p>somewhere in your website.</p>
<p>To show a form to filter the entries put</p>
<pre> <& blog show="filter" / &></pre>
<p>in your page source.</p>
<p>If you want to get your content as an RSS 2.0 compliant XML file you may want to put</p>
<pre> <& blog show="rss2" / &></pre>
<p>alone in a separate file.</p>
<p>The HTTP parameters "email" and "pass" will be used to log on the user before retrieving the entries. This will also return private entries.</p>
<h1><a class='u' href='#___top' title='click to go to top of document'
name="CONFIGURATION"
>CONFIGURATION</a></h1>
<p>You may do some configuration in your konstrukt.settings to let the plugin know where to get its data and which layout to use. Default:</p>
<pre> #backend
blog/backend DBI
#layout
blog/entries_per_page 5
blog/template_path /templates/blog/
#user levels
blog/userlevel_write 1
blog/userlevel_admin 2
#rss export
blog/rss2_template /templates/blog/export/rss2.template
blog/rss2_entries 20 #number of exported entries
#prefix for cached rendered article markup
blog/cache_prefix blog_article_cache/
#use a captcha to prevent spam
blog/use_captcha 1 #you have to put <& captcha / &> inside your add-template</pre>
<p>See the documentation of the backend modules (e.g. <a href="../../Konstrukt/Plugin/blog/DBI.html#CONFIGURATION" class="podlinkpod"
>"CONFIGURATION" in Konstrukt::Plugin::blog::DBI</a>) for their configuration.</p>
<h1><a class='u' href='#___top' title='click to go to top of document'
name="METHODS"
>METHODS</a></h1>
<h2><a class='u' href='#___top' title='click to go to top of document'
name="execute_again"
>execute_again</a></h2>
<p>Yes, this plugin may return dynamic nodes (i.e. template nodes).</p>
<h2><a class='u' href='#___top' title='click to go to top of document'
name="init"
>init</a></h2>
<p>Initializes this object. Sets $self->{backend} and $self->{template_path}. init will be called by the constructor.</p>
<h2><a class='u' href='#___top' title='click to go to top of document'
name="install"
>install</a></h2>
<p>Installs the templates.</p>
<p><b>Parameters:</b></p>
<p>none</p>
<h2><a class='u' href='#___top' title='click to go to top of document'
name="prepare"
>prepare</a></h2>
<p>Prepare method</p>
<p><b>Parameters</b>:</p>
<ul>
<li>$tag - Reference to the tag (and its children) that shall be handled.</li>
</ul>
<h2><a class='u' href='#___top' title='click to go to top of document'
name="execute"
>execute</a></h2>
<p>All the work is done in the execute step.</p>
<p><b>Parameters</b>:</p>
<ul>
<li>$tag - Reference to the tag (and its children) that shall be handled.</li>
</ul>
<h2><a class='u' href='#___top' title='click to go to top of document'
name="add_entry_show"
>add_entry_show</a></h2>
<p>Displays the form to add an article.</p>
<h2><a class='u' href='#___top' title='click to go to top of document'
name="add_entry"
>add_entry</a></h2>
<p>Takes the HTTP form input and adds a new blog entry.</p>
<p>Desplays a confirmation of the successful addition or error messages otherwise.</p>
<h2><a class='u' href='#___top' title='click to go to top of document'
name="edit_entry_show"
>edit_entry_show</a></h2>
<p>Grabs the article from the backend and puts it into a form from which the user may edit the article.</p>
<p>Displays the form to edit an article.</p>
<h2><a class='u' href='#___top' title='click to go to top of document'
name="edit_entry"
>edit_entry</a></h2>
<p>Takes the HTTP form input and updates the requested blog entry.</p>
<p>Displays a confirmation of the successful update or error messages otherwise.</p>
<h2><a class='u' href='#___top' title='click to go to top of document'
name="delete_entry_show"
>delete_entry_show</a></h2>
<p>Displays the confirmation form to delete an article.</p>
<h2><a class='u' href='#___top' title='click to go to top of document'
name="delete_entry"
>delete_entry</a></h2>
<p>Deletes the specified entry.</p>
<p>Displays a confirmation of the successful removal or error messages otherwise.</p>
<h2><a class='u' href='#___top' title='click to go to top of document'
name="show_entry"
>show_entry</a></h2>
<p>Shows the requested blog entry including its comments</p>
<p>Displays the entry or error messages otherwise.</p>
<p><b>Parameters</b>:</p>
<ul>
<li>$id - ID of the entry to show (optional)</li>
</ul>
<h2><a class='u' href='#___top' title='click to go to top of document'
name="show_entries"
>show_entries</a></h2>
<p>Shows the blog entries</p>
<p>Displays the entries or error messages otherwise.</p>
<h2><a class='u' href='#___top' title='click to go to top of document'
name="format_and_cache_content"
>format_and_cache_content</a></h2>
<p>Take plain text and formats it using the wiki plugin. Caches the result. If a cached file already exists, the cached result will be used.</p>
<p>Returns a field tag node contatining the formatted output nodes.</p>
<p><b>Parameters</b>:</p>
<ul>
<li>$id - The ID of the article</li>
<li>$content - The (plaintext) content</li>
</ul>
<h2><a class='u' href='#___top' title='click to go to top of document'
name="delete_cache_content"
>delete_cache_content</a></h2>
<p>Deletes the content cache for a given article</p>
<p><b>Parameters</b>:</p>
<ul>
<li>$id - The ID of the article</li>
</ul>
<h2><a class='u' href='#___top' title='click to go to top of document'
name="add_comment_show"
>add_comment_show</a></h2>
<p>Takes the specified entry ID or HTTP form input and shows the form to add a comment.</p>
<p>Displays the form to add a comment.</p>
<p><b>Parameters</b>:</p>
<ul>
<li>$id - ID of the entry, which shall be commented. (optional)</li>
</ul>
<h2><a class='u' href='#___top' title='click to go to top of document'
name="add_comment"
>add_comment</a></h2>
<p>Takes the HTTP form input and adds a new comment.</p>
<p>Displays a confirmation of the successful addition or error messages otherwise.</p>
<h2><a class='u' href='#___top' title='click to go to top of document'
name="delete_comment"
>delete_comment</a></h2>
<p>Takes the HTTP form input and removes an existing comment.</p>
<p>Displays a confirmation of the successful removal or error messages otherwise.</p>
<h2><a class='u' href='#___top' title='click to go to top of document'
name="filter_show"
>filter_show</a></h2>
<p>Displays the form to select articles.</p>
<h2><a class='u' href='#___top' title='click to go to top of document'
name="export_rss"
>export_rss</a></h2>
<p>Generates an RSS 2.0 compliant XML file with the content from the database.</p>
<h1><a class='u' href='#___top' title='click to go to top of document'
name="AUTHOR"
>AUTHOR</a></h1>
<p>Copyright 2006 Thomas Wittek (mail at gedankenkonstrukt dot de). All rights reserved.</p>
<p>This document is free software. It is distributed under the same terms as Perl itself.</p>
<h1><a class='u' href='#___top' title='click to go to top of document'
name="SEE_ALSO"
>SEE ALSO</a></h1>
<p><a href="../../Konstrukt/Plugin/blog/DBI.html" class="podlinkpod"
>Konstrukt::Plugin::blog::DBI</a>, <a href="../../Konstrukt/Plugin.html" class="podlinkpod"
>Konstrukt::Plugin</a>, <a href="../../Konstrukt.html" class="podlinkpod"
>Konstrukt</a></p>
<p class="backlinkbottom"><b><a name="___bottom" href="../../index.html" title="All Documents"><<</a></b></p>
<!-- end doc -->
</body></html>