[phpwiki-checkins] SF.net SVN: phpwiki:[8736] trunk

[<var...@us...>]

Revision: 8736
          http://sourceforge.net/p/phpwiki/code/8736
Author:   vargenau
Date:     2013-04-02 08:25:32 +0000 (Tue, 02 Apr 2013)
Log Message:
-----------
Move info from code to help page

Modified Paths:
--------------
    trunk/lib/plugin/WikiBlog.php
    trunk/pgsrc/Help%2FWikiBlogPlugin

Modified: trunk/lib/plugin/WikiBlog.php
===================================================================
--- trunk/lib/plugin/WikiBlog.php	2013-03-20 21:10:08 UTC (rev 8735)
+++ trunk/lib/plugin/WikiBlog.php	2013-04-02 08:25:32 UTC (rev 8736)
@@ -30,28 +30,6 @@
  * This plugin shows 'blogs' (comments/news) associated with a
  * particular page and provides an input form for adding a new blog.
  *
- * USAGE:
- * Add <<WikiBlog >> at your PersonalPage and BlogArchive and
- * BlogJournal will find the Blog entries automatically.
- *
- * Now it is also the base class for all attachable pagetypes:
- *    "wikiblog", "comment" and "wikiforum"
- *
- * HINTS/COMMENTS:
- *
- * To have the blog show up on a separate page:
- * On TopPage, use
- *   <<WikiBlog mode=add>>
- * Create TopPage/Blog with this page as actionpage:
- *   <<WikiBlog pagename=TopPage mode=show>>
- *
- * To have the main ADMIN_USER Blog appear under Blog and not under WikiBlog/Blog
- * or UserName/Blog as for other users blogs,
- * define BLOG_DEFAULT_EMPTY_PREFIX=true
- * use the page Blog as basepage
- * and user="" (as default for ADMIN or current user) and pagename="Blog"
- * in the various blog plugins (BlogArchives, BlogJournal)
- *
  * TODO:
  *
  * It also works as an action-page if you create a page called 'WikiBlog'
@@ -94,16 +72,6 @@
     }
 
     // Arguments:
-    //  page - page which is blogged to (default current page)
-    //
-    //  order - 'normal' - place in chronological order
-    //        - 'reverse' - place in reverse chronological order
-    //
-    //  mode - 'show' - only show old blogs
-    //         'add' - only show entry box for new blog
-    //         'show,add' - show old blogs then entry box
-    //         'add,show' - show entry box followed by old blogs
-    //
     // TODO:
     //
     // - arguments to allow selection of time range to display

Modified: trunk/pgsrc/Help%2FWikiBlogPlugin
===================================================================
--- trunk/pgsrc/Help%2FWikiBlogPlugin	2013-03-20 21:10:08 UTC (rev 8735)
+++ trunk/pgsrc/Help%2FWikiBlogPlugin	2013-04-02 08:25:32 UTC (rev 8736)
@@ -1,4 +1,4 @@
-Date: Fri, 13 Apr 2012 18:14:27 +0000
+Date: Tue,  2 Apr 2013 10:23:48 +0000
 Mime-Version: 1.0 (Produced by PhpWiki 1.4.0)
 Content-Type: application/x-phpwiki;
   pagename=Help%2FWikiBlogPlugin;
@@ -9,10 +9,68 @@
 
 This simple [[Help:WikiPlugin|plugin]] allows blog-style entries on a page. Try making a few entries, and then look at [[RecentChanges]] to get an idea of how things work.
 
+This plugin shows 'blogs' (comments/news) associated with a
+particular page and provides an input form for adding a new blog.
+
+== Arguments ==
+
+{| class="bordered"
+|-
+! Argument
+! Description
+! Default value
+|-
+| **page**
+| page which is blogged to 
+| Current page
+|- 
+| **order**
+|
+* 'normal' - place in chronological order
+* 'reverse' - place in reverse chronological order
+| normal
+|-
+| **mode**
+|
+* 'show' - only show old blogs
+* 'add' - only show entry box for new blog
+* 'show,add' - show old blogs then entry box
+* 'add,show' - show entry box followed by old blogs
+| show,add
+|}
+
+== Usage ==
+
+Add {{{<<WikiBlog>>}}} at your ~PersonalPage and BlogArchives and
+BlogJournal will find the Blog entries automatically.
+
+Now it is also the base class for all attachable pagetypes:
+"wikiblog", "comment" and "wikiforum"
+
+== Hints/comments ==
+
+To have the blog show up on a separate page:
+
+On ~TopPage, use {{{<<WikiBlog mode=add>>}}}
+Create ~TopPage/Blog with this page as actionpage:
+{{{<<WikiBlog pagename=TopPage mode=show>>}}}
+
+To have the main ADMIN_USER Blog appear under Blog and not under WikiBlog/Blog
+or ~UserName/Blog as for other users blogs,
+define BLOG_DEFAULT_EMPTY_PREFIX=true
+use the page Blog as basepage
+and user="" (as default for ADMIN or current user) and pagename="Blog"
+in the various blog plugins (BlogArchives, BlogJournal)
+
 == Example ==
 
 <<WikiBlog>>
 
+== Author ==
+* Michael Van Dam, major refactor by [[Help:Jeff Dairiki|Jeff Dairiki]] (as ~AddComment)
+* Changed as baseclass to ~AddComment and ~WikiForum and ~EditToolbar integration by [[Help:Reini Urban|Reini Urban]].
+
+
 == See Also ==
 * [[Help:BlogJournalPlugin]]
 * [[Help:BlogArchivesPlugin]]

This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site.