DokuWiki

It's better when it's simple

User Tools

Site Tools


plugin:blog

Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Both sides previous revisionPrevious revision
Next revision
Previous revision
plugin:blog [2016-05-03 12:41] – [FAQ] 201.212.171.214plugin:blog [2023-10-30 23:08] (current) Klap-in
Line 2: Line 2:
  
 ---- plugin ---- ---- plugin ----
-description: Use DokuWiki as blogging tool.+description: Use DokuWiki as blogging tool
 author     : Dokufreaks (previous author: Michael Hamann, Gina Häußge, Michael Klier, Esther Brunner) author     : Dokufreaks (previous author: Michael Hamann, Gina Häußge, Michael Klier, Esther Brunner)
 email      : freaks@dokuwiki.org email      : freaks@dokuwiki.org
 type       : syntax, action, helper type       : syntax, action, helper
-lastupdate : 2016-04-26 +lastupdate : 2023-10-24 
-compatible : 2008-05-05, 2009-02-14, Detritus, Lemming, Anteater, Rincewind, Angua, Adora Belle, Weatherwax, Binky, Ponder Stibbons+compatible : Lemming, Anteater, Rincewind, Angua, Adora Belle, Weatherwax, Binky, Ponder Stibbons, Hrun, Detritus, Elenor of Tsort, Frusterick Manners, Greebo, Hogfather, Igor, Jack Jackrum
 depends    : include, pagelist depends    : include, pagelist
 conflicts  conflicts 
-similar    : +similar    : blogtng, miniblog
 tags       : blog, news tags       : blog, news
  
Line 20: Line 20:
 ===== Description ===== ===== Description =====
  
-The Blog [[plugins|Plugin]] makes blogs in your wiki easily possible. The [[#blog]] component shows the latest entries (pages) from a namespace in reverse chronological order. In this new version, the creation date is the sort key -- no longer the date of the last non-minor modification as in previous versions. The [[#archive]] component lists all entries that were written (created) in the given month.+The Blog Plugin makes blogs in your wiki easily possible. The [[#blog]] component shows the latest entries (pages) from a namespace in reverse chronological order. In this new version, the creation date is the sort key -- no longer the date of the last non-minor modification as in previous versions. The [[#archive]] component lists all entries that were written (created) in the given month. 
 ===== Installation ===== ===== Installation =====
  
-^  Download   | [[https://github.com/dokufreaks/plugin-blog/tarball/master|plugin-blog.tgz]] | +^  Download   | [[https://github.com/dokufreaks/plugin-blog/tarball/master|plugin-blog.tgz]]                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  
-^  BundleHub  | Configure your own DokuWiki blogsuite install package, consisting of all mandatory plugins plus any optional features you want to include: \\ [[http://dokuwiki.foosel.org/blogsuite/index.php|BlogSuite BundleHub]] :!: ** The Bundle Hub is currently out of date and not updated anymore, please install the plugins individually** :!: \\ FIXME Site seems to be down for sime time, [[http://web.archive.org/web/20120110121631/http://dokuwiki.foosel.org/blogsuite/index.php|here is the archived version]] if you want to see possible optional plugins & features. | +^  BundleHub  | Configure your own DokuWiki blogsuite install package, consisting of all mandatory plugins plus any optional features you want to include: \\ [[http://dokuwiki.foosel.org/blogsuite/index.php|BlogSuite BundleHub]] :!: ** The Bundle Hub is currently out of date and not updated any more, please install the plugins individually** :!: \\ FIXME Site seems to be down for sime time, [[http://web.archive.org/web/20120110121631/http://dokuwiki.foosel.org/blogsuite/index.php|here is the archived version]] if you want to see possible optional plugins & features.  
-^  Tips       | If you intend to use this plugin be sure to take a look at the [[tips:blogging|blogging tips page]] |+^  Tips       | If you intend to use this plugin be sure to take a look at the [[tips:blogging|blogging tips page]]                                                                                                                                                                                                                                                                                                                                                                                                                                                                           |
  
 ===== Syntax ===== ===== Syntax =====
Line 39: Line 40:
 ^     ::: | Form placement: ''topform''/''bottomform''/''noform'' | optional, default is ''topform'' | ^     ::: | Form placement: ''topform''/''bottomform''/''noform'' | optional, default is ''topform'' |
 ^     ::: | Custom new-entry form title: ''newentrytitle=Custom title'' | optional, can also be set as a [[#configuration_and_settings|configuration option]] | ^     ::: | Custom new-entry form title: ''newentrytitle=Custom title'' | optional, can also be set as a [[#configuration_and_settings|configuration option]] |
 +^     ::: | Hide paging controls: ''nopagingcontrols'' | optional |
  
 This includes a specified number of most recent blog entries from the given namespace into the current page. Below the entries a link to the page (permalink), the author, the creation date and the number of comments are shown. Link, author, date and comments info can be hidden. At the end of the blog a link to older entries lets you navigate in the history of the blog. At the very end, if you have enough rights to create new pages, a form for new blog entries is displayed. This includes a specified number of most recent blog entries from the given namespace into the current page. Below the entries a link to the page (permalink), the author, the creation date and the number of comments are shown. Link, author, date and comments info can be hidden. At the end of the blog a link to older entries lets you navigate in the history of the blog. At the very end, if you have enough rights to create new pages, a form for new blog entries is displayed.
 +
 +Note that when the page with the blog syntax is in the specified namespace, content my be shown twice. At some point, the loop will be detected and stopped. You should therefore make sure that either the page with the listing is in a different namespace or use the ''excluded_pages''-option to explicitly exclude the blog page from the blog listing.
  
  
Line 60: Line 64:
  
 ===== Configuration and Settings ===== ===== Configuration and Settings =====
 +
 The blog plugin can be configured using the DokuWiki configuration manager available in the admin menu. The blog plugin can be configured using the DokuWiki configuration manager available in the admin menu.
  
-^ ''namespace'' | The default namespace which is used if no namespace was given in the syntax | +^ ''namespace''         | The default namespace which is used if no namespace was given in the syntax                                                                                                                                   
-^ ''formposition'' | You can choose to display the new entry form either above or below the blog entries | +^ ''formposition''      | You can choose to display the new entry form either above or below the blog entries                                                                                                                           
-^ ''newentrytitle'' | Set a custom title for all new entry forms.  This can also be set on individual blog forms. | +^ ''newentrytitle''     | Set a custom title for all new entry forms.  This can also be set on individual blog forms.                                                                                                                   
-^ ''dateprefix'' | A date prefix that automatically gets added to pages created with the new entry form. You can use the options from the [[phpnet>strftime]] PHP function; namespace separators work as well, e.g. ''%Y:%m%d''+^ ''dateprefix''        | A date prefix that automatically gets added to pages created with the new entry form. You can use the options from the [[phpnet>strftime]] PHP function; namespace separators work as well, e.g. ''%Y:%m%d''  
-^ ''sortkey'' | Defines how the blog entries are sorted. Available options are creation date, modification date, page name, page ID and page title (first headline) | +^ ''sortkey''           | Defines how the blog entries are sorted. Available options are creation date, modification date, page name, page ID and page title (first headline)                                                           
-^ ''sortorder'' | Sort the blog entries ascending/descending | +^ ''sortorder''         | Sort the blog entries ascending/descending                                                                                                                                                                    | 
-^ ''showhistogram'' | Display a histogram in normal archive mode (not for autoarchive) |+^ ''excluded_pages''    | Exclude certain pages from the blog listing. Requires a regular expression. Use for example ''%%!(^|:)start$!%%'' in order to exclude start pages from all blog listings.  \\ To exclude both start and rightsidebar directly below :blog use \\ ''!(^|:)blog:(start|rightsidebar)$!''    
 +^ ''showhistogram''     | Display a histogram in normal archive mode (not for autoarchive)                                                                                                                                              | 
 +^ ''max_months''        | Maximum number of months to show in the histogram                                                                                                                                                             | 
 +^ ''histogram_height''  | Height of the histogram (in pixels)                                                                                                                                                                           |
  
 ===== Changes ===== ===== Changes =====
Line 85: Line 93:
  
 === Bugs / Feature Requests === === Bugs / Feature Requests ===
 +
 Please report bugs or feature requests at the [[https://github.com/dokufreaks/plugin-blog/issues|Bug tracker]]. Please report bugs or feature requests at the [[https://github.com/dokufreaks/plugin-blog/issues|Bug tracker]].
  
  
 ===== FAQ ===== ===== FAQ =====
 +
 Please also have a look at the [[tips:blogging]] tips page! Please also have a look at the [[tips:blogging]] tips page!
  
 === My dates are shown wrong. What can I do? === === My dates are shown wrong. What can I do? ===
 +
 Make sure you run the latest version of all required plugins and DokuWiki. Make sure you run the latest version of all required plugins and DokuWiki.
  
 === Is it possible to change the way the date is displayed? === === Is it possible to change the way the date is displayed? ===
 +
 Yes, the plugin uses the [[config:dformat]] option to format the date. Yes, the plugin uses the [[config:dformat]] option to format the date.
  
 === How can I alter the date of a blog post? === === How can I alter the date of a blog post? ===
 +
 You can use the [[plugin:meta]] plugin to manually set the creation date (and modification date) in the page source, then select the modification date in the blog plugins order setting. An alternative solution would be to alter the timestamps of the created files. You can use the [[plugin:meta]] plugin to manually set the creation date (and modification date) in the page source, then select the modification date in the blog plugins order setting. An alternative solution would be to alter the timestamps of the created files.
  
 === Is it possible to show table of contents? === === Is it possible to show table of contents? ===
 +
 The table of contents is shown automatically (depending on the settings in DokuWiki itself) from version 2013-02-07 on. The table of contents is shown automatically (depending on the settings in DokuWiki itself) from version 2013-02-07 on.
  
Line 116: Line 130:
 This will work if you add an H2 header (in the full post) where you want to make appear the 'Read more' link. This will work if you add an H2 header (in the full post) where you want to make appear the 'Read more' link.
 If you don't need or want an H2 header in your post, you can add a empty H2 header, just as a delimiter for the text you want to show in the Blog's headlines If you don't need or want an H2 header in your post, you can add a empty H2 header, just as a delimiter for the text you want to show in the Blog's headlines
 +
 +
 +=== the excluded_pages does not work ===
 +
 +In the blog mark ,use the following flags
 +  {{blog>*?5&!(^|:)index$!}}
 +  or
 +  {{blog>*?5&excluded_pages=!(^|:)index$!}}
 +
 +all above flags does not work, the index pages in sub namespace is still included .
 +
 +> This is global configuration, you should configure it in ''Configuration Manager''. --- //Siyuan Liu 2023-08-17//
 +
  
 ===== Discussion ===== ===== Discussion =====
plugin/blog.1462272112.txt.gz · Last modified: 2016-05-03 12:41 by 201.212.171.214

Except where otherwise noted, content on this wiki is licensed under the following license: CC Attribution-Share Alike 4.0 International
CC Attribution-Share Alike 4.0 International Donate Powered by PHP Valid HTML5 Valid CSS Driven by DokuWiki