DokuWiki

It's better when it's simple

User Tools

Site Tools


plugin:var

Variable Plugin

Compatible with DokuWiki

  • 2017-02-19 "Frusterick Manners" yes
  • 2016-06-26 "Elenor Of Tsort" yes
  • 2015-08-10 "Detritus" yes
  • 2014-09-29 "Hrun" yes

plugin Displays some dynamic info about the current page, user or date. It uses exactly the same syntax and variables as namespace templates.

Last updated on
2017-06-11
Provides
Syntax
Repository
Source

Tagged with date, email, include, template, users

Installation

Use this address plugin-var for installing it through the plugin manager. If your wiki installation is hosted on a platform that can't download plugins via HTTPS, you can feed the plugin manager this link instead for a copy of the plugin as it is at Jan 2017.

Syntax

@ID@ full ID of the page
@NS@ namespace of the page
@PAGE@ page name (ID without namespace and underscores replaced by spaces)
@USER@ ID of current user
@NAME@ full name of current user
@MAIL@ mail address of current user
@DATE@ current date
@YEAR@ current year in YYYY format
@MONTH@ current month in MM format
@DAY@ current day in DD format
@TITLE@ first heading of the current page
@WIKI@ title of the wikis as configured in title
@SERVER@ the content of $_SERVER['SERVER_NAME']
@VER@ the contents returned by getVersion(), such as “Release 2013-12-08 “Binky”
@VERR@ the release date as extracted from getVersion()
@VERN@ the release name as extracted from getVersion()
@ALIAS@ the e-mail alias of the current user e.g. john.doe. If a different separator than the dot is required you can also use @ALIAS_@ or @ALIAS-@

:!: This plugin doesn't work within titles, links and other substitution patterns, for technical reasons.

Use this plugin only when necessary. It turns caching for the current page off, which may have a negative effect on performance.

Live tests available for various Wiki versions: http://ryan.gulix.cl/tests.doku/current_/ (the start page of each wiki demonstrates the plugin).

Development

New Management

I'd like to announce my intentions of maintaining this plugin starting Jan 2011, after Chi's (let's hops temporary) exit of the DokuWiki development world. As a starting point a new demo page as well as screenshots and localization strings will be developed in for the next release, which will bring few if any behavioural modifications. More Info [dokuwiki]ryan.chappelleLuis Machuca Bezzaza
ryan.chappelle

2010/12/18 19:34

After… a lot of time, I pushed an update which incorporates variables for Dokuwiki version information. — Luis Machuca BezzazaLuis Machuca Bezzaza
ryan.chappelle

2015-06-28 19:49

Changelog

FAQ

Is there any way of using these variables within a <code> block?

Not in any practical way. The unformatted modes (code, file, nowiki) prevent the plugins from replacing content – and that's expected, since unformatted is for for pasting content verbatim. — Luis 2010/02/23 18:22

Will this work with the templater-plugin?

You can use the @-Placeholders on the page where you use the

{{template>pagename}}

syntax. It's not working inside the sections which have been included by the templater-plugin.

Discussion

Hello Is there a chance of using a variable like @ID@ in the pagequery plugin? I tried it but it didn't work. Thanks, Daniel

After studying the features of this plugin, I have to say this is great. The fact that it can not parse inside links or other constructs (for example, I tried using this alongside the Data Plugin) is somewhat of an hindrance, but it can be overcome with careful design. However, I would like to propose new variables to be integrated in this plugin, if possible. Among the ones I've planned, I think the following may be useful:

  • @TITLE@, to expand into the Page Title available via the first header, if the $conf['useheading'] option is enabled. That would be essentially a user-friendly alternative to @PAGE@ where needed.
  • @WIKI@, to expand to the Wiki Name as defined via $conf['title'], and @SERVER@, to expand to the server name as provided by Apache. Mostly to provide uniformity on document-oriented wikis and make them domain-independant if migrations or company changes occur.

I want to leave these two for a proposal. — — Luis Machuca B. 2009/01/30 20:05

Done! — Michael Klier 2009/03/25 11:40
plugin/var.txt · Last modified: 2017-07-11 16:11 by KaiMartin