DokuWiki

It's better when it's simple

User Tools

Site Tools


plugin:fields

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:fields [2010-07-25 14:55] – update sig abompardplugin:fields [2024-01-04 04:03] (current) Aleksandr
Line 1: Line 1:
-====== fields plugin ======+====== fields Plugin ======
  
 ---- plugin ---- ---- plugin ----
 description: Allows storage and retrieval of user-defined fields throughout the page description: Allows storage and retrieval of user-defined fields throughout the page
-author     : Aurélien Bompard+author     : Aurélien Bompard, lpaulsen93
 email      : aurelien@bompard.org email      : aurelien@bompard.org
 type       : syntax type       : syntax
-lastupdate : 2010-07-24 +lastupdate : 2021-03-27 
-compatible : 2006-11-06+compatible : Binky, Adora Belle, 2006-11-06, 2016-06-26 "Elenor Of Tsort", Greebo, Hogfather
 depends    :  depends    : 
 conflicts  conflicts 
-similar    : data+similar    : data, easyvar, replace, kixovar, macros, textinsert
 tags       : meta, odt, replace tags       : meta, odt, replace
-downloadurl: http://aurelien.bompard.org/projects/files/dokuwiki-fields/dokuwiki-fields-20080303.zip + 
-sourcerepo : http://gitorious.org/dokuwiki-fields +downloadurl: https://github.com/lpaulsen93/dokuwiki-plugin-fields/archive/master.zip 
-bugtracker : http://aurelien.bompard.org/projects/dokuwiki-fields+sourcerepo : https://github.com/lpaulsen93/dokuwiki-plugin-fields 
 +bugtracker : https://github.com/lpaulsen93/dokuwiki-plugin-fields/issues
 donationurl: https://www.paypal.com/cgi-bin/webscr?cmd=_donations&business=59CSTDNRERRNU&lc=FR&item_name=Aur%c3%a9lien%20Bompard&item_number=dokuwiki&currency_code=EUR&bn=PP%2dDonationsBF%3abtn_donate_SM%2egif%3aNonHosted donationurl: https://www.paypal.com/cgi-bin/webscr?cmd=_donations&business=59CSTDNRERRNU&lc=FR&item_name=Aur%c3%a9lien%20Bompard&item_number=dokuwiki&currency_code=EUR&bn=PP%2dDonationsBF%3abtn_donate_SM%2egif%3aNonHosted
 ---- ----
  
-This plugin allows you to define "fields" in a page, which can be used anywhere ((it doesn't appear to work in headings)) in the document. This can be very useful to set an author name, a reference string, or a version number for example, and use those variables anywhere in the page.+This plugin allows you to define "fields" in a page, which can be used anywhere ((it doesn't appear to work in headings, not in DATA plugin)) in the document. This can be very useful to set an author name, a reference string, or a version number for example, and use those variables anywhere in the page.
  
  
 ===== Download ===== ===== Download =====
  
-The plugin can be downloaded from here: [[http://aurelien.bompard.org/projects/files/dokuwiki-fields/dokuwiki-fields-20080303.zip|dokuwiki-fields-20080303.zip]] ([[http://aurelien.bompard.org/projects/files/dokuwiki-fields/dokuwiki-fields-20080303.zip.asc|signature]])Older releases are available [[http://aurelien.bompard.org/projects/files/dokuwiki-fields/|here]].+Search and install the plugin using the [[plugin:extension|Extension Manager]]. Refer to [[:Plugins]] on how to install plugins manually.
  
-I use [[wp>Git (software)|Git]] to manage the source code, which is [[http://gitorious.org/dokuwiki-fields|hosted on Gitorious]]. You can obtain the development version with this command : +I use [[wp>Git (software)|Git]] to manage the source code, which is [[https://github.com/lpaulsen93/dokuwiki-plugin-fields|hosted on Github]]. You can obtain the development version with this command : 
-<code>git clone git://gitorious.org/dokuwiki-fields/dokuwiki-fields.git</code>+<code>git clone https://github.com/lpaulsen93/dokuwiki-plugin-fields.git</code>
  
 Some interesting links on Git: Some interesting links on Git:
Line 33: Line 34:
   * [[http://www.kernel.org/pub/software/scm/git/docs/gittutorial.html|A tutorial introduction to Git]].   * [[http://www.kernel.org/pub/software/scm/git/docs/gittutorial.html|A tutorial introduction to Git]].
  
-If you have any requests (bugs, features, etc.), please use [[http://aurelien.bompard.org/projects/dokuwiki-fields|the plugin's tracker]], I don't monitor this page.+If you have any requests (bugs, features, etc.), please use [[https://github.com/lpaulsen93/dokuwiki-plugin-fields/issues|the plugin's tracker]], I don't monitor this page.
  
 ===== Usage ===== ===== Usage =====
Line 43: Line 44:
 where "FIELD_NAME" is the name of the field and "FIELD_VALUE" is the value (obviously :) ). Neither the name nor the value need to be uppercase, in fact they may contain any character. The field value can even contain equal signs ("="). where "FIELD_NAME" is the name of the field and "FIELD_VALUE" is the value (obviously :) ). Neither the name nor the value need to be uppercase, in fact they may contain any character. The field value can even contain equal signs ("=").
  
-To **display a field**, use the following syntax :+To **display a field**, use the following syntax:
  
 <code>{{fields>FIELD_NAME}}</code> <code>{{fields>FIELD_NAME}}</code>
  
-**Note** : This plugin supports XHTML rendering as well as [[plugin:odt|ODT rendering]].+**Note**: This plugin supports XHTML rendering as well as [[plugin:odt|ODT rendering]].
  
 ==== Usage in ODT rendering ==== ==== Usage in ODT rendering ====
Line 59: Line 60:
 ===== Discussion ===== ===== Discussion =====
  
-Feel free to contact me by mail, as I don't monitor this page. If you have any requests (bugs, features, etc.), please use [[http://aurelien.bompard.org/projects/dokuwiki-fields|the plugin's tracker]].+Feel free to contact me by mail, as I don't monitor this page. If you have any requests (bugs, features, etc.), please use [[https://github.com/lpaulsen93/dokuwiki-plugin-fields/issues|the plugin's tracker]]
 + 
 +==== Issues ==== 
 + 
 +=== Writes directly HTML code === 
 + 
 +The content of the "fields" seems to be directly output as HTML-Code((I have not looked into the plugin's code yet)), i.e. 
 + 
 +  * you cannot use any DokuWiki formatting in field content 
 +  * you //can// use nearly any HTML directive in field content - from simple font style as //italic// to :!: Script Code((only HTML based, i.e. Javascript etc. via ''<SCRIPT>'', no PHP or something via ''<?..?>''))  
 + 
 +The latter opens the usual question //bug or feature//: for my purposes in a "super-closed" wiki (only approved users can even read the wiki and not all of them can edit everything) it may be a benefit in some cases while especially **in open wikis** (anonymous people can edit) **it //is// a security hole** - __but__ @Aurélien: please do NOT retract this wonderful tool 
 + 
 + --- [[user>hh lohmann|hh lohmann]] //2014/01/10 09:10// 
 + 
 +> If this is true (also haven't checked the code yet), then this should be properly [[devel:security#reporting_security_issues|reported]] and a ''securityissue'' be added to the plugin's data. --- [[user>ach|Anika Henke]] //2014/01/14 01:37// 
 + 
 +==== Fields of Application ==== 
 + 
 +//(note: the same term "fields" here reveals to be pure coincidence!)// 
 + 
 +=== Multiple use of same token === 
 + 
 +As stated in the main description: If you have the same information at many places, you can maintain (change) it centrally by using a //field//
 + 
 +:-P You may also span this over pages by including field definitions via [[plugin:include]]. 
 + 
 + --- [[user>hh lohmann|hh lohmann]] //2014/01/10 09:17// 
 + 
 +=== Separation of presentation and content === 
 + 
 +The //fields// allow a clear and concise maintenance of data since you can access the fields' content totally apart from its presentation - vice versa you can maintain complex presentation layouts since being not intermingled with data maintenance concerns (see also [[wp>Separation of presentation and content]]). 
 + 
 +:-P In conjunction with [[plugin:include]] you can drive this further by applying (via including) a uniform and centrally (and so separately) maintained template to "local" data.
  
 +//Hint//: compare this to dokuwiki.org's uniform plugin description pages via [[plugin:repository]]
  
 + --- [[user>hh lohmann|hh lohmann]] //2014/01/10 09:17//
plugin/fields.1280062559.txt.gz · Last modified: 2010-07-25 14:55 by abompard

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