DokuWiki

It's better when it's simple

User Tools

Site Tools


plugin:htmlabstract

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:htmlabstract [2010-07-22 11:33] – [Demo] - not used anymore on tangueando.fr 84.101.192.244plugin:htmlabstract [2024-02-08 09:56] (current) Aleksandr
Line 1: Line 1:
-====== HtmlAbstract plugin ======+====== HtmlAbstract Plugin ======
  
 ---- plugin ---- ---- plugin ----
-description: Integrates local RSS feed with HTML formatted abstracts.+description: Integrates any DokuWiki RSS feed with HTML formatted abstracts
 author     : Vincent Feltz author     : Vincent Feltz
 email      : psycho@feltzv.fr email      : psycho@feltzv.fr
 type       : syntax type       : syntax
-lastupdate : 2009-12-15 +lastupdate : 2016-11-07 
-compatible : >= 2009-02-14b+compatible : 2009-02-14
 depends    :  depends    : 
 conflicts  conflicts 
 similar    :  similar    : 
-tags       : rss, abstract, html+tags       : rss, abstract, html, feed 
 + 
 +downloadurl: http://xchange.feltzv.fr/doku/htmlabstract.tgz 
 ---- ----
  
 ===== Download and Installation ===== ===== Download and Installation =====
-Here are the last version links : 
-  * [[http://www.feltzv.fr/xchange/doku_plugins/htmlabstract.tgz| .tgz]] package 
-  * [[http://www.feltzv.fr/xchange/doku_plugins/htmlabstract.zip| .zip]] package 
  
-  -  Install the plugin :  +  -  Install the plugin: 
-    * Automatically : use the [[plugin:plugin|Plugin Manager]]. +    * Automatically: Search and install the plugin using the [[plugin:extension|Extension Manager]].  
-    * Manually : unzip archive directly in ''lib/plugins/'' directory.+    * Manually: Refer to [[:Plugins]] on how to install plugins manually.
   -  That's done! Now you can configure it using the configuration page.   -  That's done! Now you can configure it using the configuration page.
-\\ 
-PS (2009/11/29): I cleaned my ant rules for building packages, sorry for those who maybe had odd files in zip or tgz... 
  
 ===== Syntax ===== ===== Syntax =====
-  {{htmlabs>[&feed=options] [integration options]}}+ 
 +  {{htmlabs><feed_url>[&feed=options] [integration options]}} 
 + 
 +==== Feed URL (mandatory) ==== 
 + 
 +  * ''feed.php'' will work with the local RSS feed of the wiki being modified 
 +  * ''%%http://any_site.com/dokuwiki/feed.php%%'' will work with any DokuWiki-generated RSS feed.
  
 ==== Feed options ==== ==== Feed options ====
-This plugin is based on the ''feed.php'' file available in the DokuWiki package, so most of options which are available for this feed are available for htmlabstract plugin too, except ''content'' option, which is set automatically for producing HTML abstracts, and ''type'' which is set automatically for htmlabstract to be able to parse it.\\ + 
-These options (linkto, mode, num, minor) and their description are viewable on [[:syndication| this page]].\\ +This plugin is made for to work with the ''feed.php'' file available in the DokuWiki package, so most of options which are available for this feed are available for htmlabstract plugin too, except ''content'' option, which is automatically set to HTML, and ''type'' which is set to RSS 2.0. 
-**Note :** these options must be separated by the ''&'' sign, and set with ''='' sign, like in URL schemes.+ 
 +These options (linkto, mode, num, minor) and their description are viewable on [[:syndication| this page]]. 
 + 
 +**Note:** these options must be separated by the ''&'' sign, and set with ''='' sign, like in URL schemes.
  
 ==== Integration options ==== ==== Integration options ====
 +
 By default, the feed will be integrated including  By default, the feed will be integrated including 
   * the title of the page as a link to the diff table (or whatever you configured using feed options)   * the title of the page as a link to the diff table (or whatever you configured using feed options)
   * the author of modifications   * the author of modifications
   * the date of the modifications   * the date of the modifications
-If you want to skip one of these details, just add one of the following options :+If you want to skip one of these details, just add one of the following options:
   * ''notitle'' (A link to the page will still append at the end of the preview)   * ''notitle'' (A link to the page will still append at the end of the preview)
   * ''noauthor''   * ''noauthor''
   * ''nodate''   * ''nodate''
 +
 +==== Plugin options ====
 +
 +These options are available in the config page.
 +  * ''paragraph'' -- if enabled, htmlabstract will try to cut the abstract at the end of a paragraph, instead of the middle of a sentence/word
 +  * ''maxlength'' -- maximal length of the abstract's text
 +  * ''textlink'' -- the text to be put at the end of abstracts as a link to the page
 +  * ''bg_color'' -- background color for abstracts
  
 ===== Examples ===== ===== Examples =====
-  {{htmlabs>num=42&ns=misc notitle noauthor}}+ 
 +  {{htmlabs>feed.php?num=42&ns=misc notitle noauthor}} 
 will integrate the 42 last modifications in the namespace ''misc'', displaying the date of modification for each item. will integrate the 42 last modifications in the namespace ''misc'', displaying the date of modification for each item.
-  {{htmlabs>minor=1 nodate}}+ 
 +  {{htmlabs>feed.php?minor=1 nodate}} 
 will integrate the ''x'' last modifications, including minor changes, and displaying the page's title and the author of the modification for each item. (''x'' being what you configured for your DokuWiki.) will integrate the ''x'' last modifications, including minor changes, and displaying the page's title and the author of the modification for each item. (''x'' being what you configured for your DokuWiki.)
  
 ===== Demo ===== ===== Demo =====
-A demonstration with three different settings is available [[http://feltzv.fr/dokuwiki/doku.php?id=misc:demo_plugin|here]].+ 
 +Please feel free to add your own links if you use it! ;-)
  
 ===== Changelog ===== ===== Changelog =====
 +
 +__**2016/11/07**__
 +  * Fixed date info in plugin description to fix a permanent update warning.
 +
 +__**2011/07/10**__
 +  * Resurrected download link thanks to Håkan Sandell who sent me a saved package of my lost code.
 +  * Fixed date display problem.
 +
 +__**2010/07/23**__
 +  * Fixed some bugs for W3C compliance. :!:**Be careful** : the __integration__ of previews in the DW page is W3C compliant, but it's yours to check that the pages you want to integrate are OK!
 +
 +__**2010/07/22**__ From suggestions by ''Vincent Fleury'' :
 +  * HtmlAbstract was severely revised, and doesn't add a feed builder anymore. This way, it shouldn't create RSS event conflicts!
 +  * Abstracts visibility is improved by a background color, which is configurable in plugin options.
 +  * Now allows to integrate another RSS feed than the local one, as long as this one is generated by a DW feed builder. (It probably could works with another feed, but parsing errors may occur... my aim wasn't here, so it's yours to test!)
 +
 __**2009/12/15**__ As suggested by ''Mc.Prins'' : __**2009/12/15**__ As suggested by ''Mc.Prins'' :
   * Now uses DOKU_URL variable for building path to feed.php, instead of $_SERVER. That should allow using this plugin even in not root-installed wikis.   * Now uses DOKU_URL variable for building path to feed.php, instead of $_SERVER. That should allow using this plugin even in not root-installed wikis.
Line 69: Line 105:
  
 ===== Nota Bene ===== ===== Nota Bene =====
 +
 Don't hesitate to post feedback (or to mail me if I don't seem to notice your remarks), and to post links to pages where this plugin is used! It's particularly motivating for enhancement! =) \\ Don't hesitate to post feedback (or to mail me if I don't seem to notice your remarks), and to post links to pages where this plugin is used! It's particularly motivating for enhancement! =) \\
 And don't forget to use [[:plugin:popularity|popularity plugin]]! ;-) And don't forget to use [[:plugin:popularity|popularity plugin]]! ;-)
Line 74: Line 111:
 ===== User feedback ===== ===== User feedback =====
  
- +>**Bug**:
->** Bug ** :\\ +
 > cache file from htmlabstract's feed is in conflict with the usual DokuWiki feed  > cache file from htmlabstract's feed is in conflict with the usual DokuWiki feed 
 > >
->**Fixes : **\\ +>**Fixes: **
 >in feed.php change  >in feed.php change 
 ><code> ><code>
Line 113: Line 149:
 </code> </code>
 > fleury vincent for : http://www.tangueando.fr > fleury vincent for : http://www.tangueando.fr
 +>> Problems solved in last update, which where there's no ''feed.php'' added. Thanks for your suggests ;-) \\ Vince / {psycho.}
  
 > Thanks! Very useful addition. With this plugin, DokuWiki can get a CMS type of "frontpage", solving the problem of what to put there. ;-) Would be nice if the date format and the "Read more" could be according to default language. Cheers! > Thanks! Very useful addition. With this plugin, DokuWiki can get a CMS type of "frontpage", solving the problem of what to put there. ;-) Would be nice if the date format and the "Read more" could be according to default language. Cheers!
plugin/htmlabstract.1279791228.txt.gz · Last modified: 2010-07-22 11:33 by 84.101.192.244

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