DokuWiki

It's better when it's simple

User Tools

Site Tools


plugin:editformhelppage

editformhelppage plugin

Compatible with DokuWiki

2009-02-14b

plugin Lets you display a user configurable page below edit form with custom content to help with editing.

Last updated on
2009-09-02
Provides
Action

This extension has not been updated in over 2 years. It may no longer be maintained or supported and may have compatibility issues.

Tagged with editing

By paxman

Information

With this plugin you can set a page to be displayed under the edit form when editing/previewing some page, to help you - either by having written syntax examples, notes, links to images, page templates, useful snippets, etc.

Download and Installation

Tar.gz-ed and zip archive. FIXME Deleted files

Note: this is NOT plugin manager package! You'll have to create an editformhelppage folder under /your/dokuwiki/root/folder/lib/plugins and copy the archive contents into it yourself.

Configuration

You can set the page to be displayed in Admin/Configuration settings/Editformhelppage section. Page name can be relative or absolute. You must also manually create the page in question.

Usage

No special requirements, just edit some page and scroll below the edit form. :)

Template compatibility

Successfully tested under ameoto, simple, default, typo, influence, backback, bf3sunshine.

Tips & Hints

For best result I suggest you use tabinclude and nstoc plugins. The former for making the help page shorter (scrolling down multiple pages composed in one can can be a PITA, even the default Formatting syntax is quite long); - of course, you must also manually create all pages you would like to include - the latter because the page's table of contents doesn't get displayed, so you must include one manually. Uparrow plugin is also great, as it automatically creates an up arrow, which links to the top of the page, so you don't need to scroll so much.

  • For tabinclude to work best, you should disable the Hide connecting message - or else it does not load page on tab click - and enable Show source page name - if you want the tab to display the title written on page (===== SomeTitle =====), not the name the page was created under.
  • The nstoc needs a change so that it doesn't redirect you to the real page; change the
    $link = '<a class="wikilink1" href="' . wl($id) . '#';

    line in syntax.php to:

      $link = '<a class="wikilink1" href="#';

(See examples below for the results.)

Examples

Default example:

Default example source:

 ===== Help =====
 Under these tabbed pages, you will find examples for the default syntax as well as third-party plugins and some premade page templates or useful snippets.

Tabinclude example:

Tabinclude page source:

{{tabinclude>.:help,.:wiki:syntax,.:plugin_examples,.:snippets}}

Nstoc example:

Nstoc example source:

 {{nstoc plugin_examples 3}}

 ===== Plugin syntax =====
 ...

Discussion

I can't download the plugin, it has been removed from rapidshare.

plugin/editformhelppage.txt · Last modified: 2011-06-18 16:53 by ach