Quick tip box with DokuWiki Syntax

ucffool

2008-04-21, 23:47 #1

Member for a month · 2 posts
Group memberships: Members

Show profile ·

Link to this post

Subject: Quick tip box with DokuWiki Syntax

I'm trying to find the wikiesque website that had something like this, something I saw on digg that was basically an actress/hot babe wiki run by hi-5 or one of those sites.
Oh well.

Anyway, the idea is that for those unfamiliar with wiki syntax, and without them having to have a second window open with the :syntax, a small box below the editing window with common things, like [[pagename|text]] and other useful tidbits not addressed with the quickbuttons at the top of the editor.

I couldn't find anything like this, and wondering if I'm missing it or it just doesn't exist yet.

This post was edited on 2008-04-22, 18:59 by ucffool.

ucffool

2008-04-22, 18:56 #2

Member for a month · 2 posts
Group memberships: Members

Show profile ·

Link to this post

Subject: More info...

So I've done some hacking to give you an idea of what I'm talking about (See a screenshot).
The following was changed within my template (I use masa) to make this show up.

main.php (around line 112)

<?php } else { ?>

      <div class="page">

      

      <?php tpl_content()?>

      

      </div>


<div id='syntax_help'>
    <h2>Common Syntax</h2>
    [[ http://www.example.com | link text ]]
      <ul><li>Link to a specific external URL while displaying different link text</li></ul>
    [[ pagename | link text ]]
      <ul><li>Link to a specific pagename while displaying different link text</li></ul>
    [[ pagename:namespace ]]
      <ul><li>Link to a specific namespace on pagename</li></ul>
    [[ pagename:namespace | link text ]]
      <ul><li>Link to a specific namespace on pagename while displaying different link text</li></ul>
    ((This is a footnote))
      <ul><li>Create a footnote</li></ul>
    * This is an unordered list item
      <ul><li>Create an unordered list with the asterisk (*)</li></ul>
    - This is an ordered list item
      <ul><li>Create an ordered list with the hyphen (-)</li></ul>
</div>
<div id='plugins_help'>
    <h2>Plugins available</h2>
    <ul>
    <li><a href="http://wiki.splitbrain.org/plugin:gallery">Gallery</a></li>
      <ul><li>[[ gallery>namespace ]]</ul></li>
    <li><a href="http://wiki.splitbrain.org/plugin:code2">Code2</a></li>
      <ul><li><code lang linenum></code></ul></li>
      <ul><li><b>Example:</b> <code php 7></code></ul></li>
    <li><a href="http://wiki.splitbrain.org/plugin:poll">Poll</a></li>
    <li><a href="http://www.wikidesign/en/plugin/pagelist/start">Pagelist</a></li>
    <li><a href="http://wiki.splitbrain.org/plugin:note">Note</a></li>
      <ul><li><note></note></ul></li>
      <ul><li><note warning></note></ul></li>
      <ul><li><note tip></note></ul></li>
      <ul><li><note important></note></ul></li>
    <li><a href="http://wiki.splitbrain.org/plugin:keywords">Keywords</a></li>
      <ul><li>{{keywords>word1 word2 wordN}}</ul></li>
    </ul>
</div>

    <?php } ?>

masa_design.css (at the bottom)

#syntax_help {
    clear: both;
    display: block;
    width: 40%;
    border: 1px dashed;
    margin-left: 10px;
    padding: 0 5px 0 15px;
    float: left;
}

#plugins_help {
    display: block;
    border: 1px dashed;
    width: 40%;
    margin-right: 30px;
    padding: 0 5px 0 15px;
    float: right;
}

#plugins_help a:link {
    text-decoration: underline;
}
#plugins_help a:visited {
    text-decoration: underline;
}

Realistically, the plugins sections would be dynamic based upon the stored info about installed plugins. Secondly, the current placement shows up only when you are on the EDIT page, but it does also show up on the ADMIN page. I suppose it would best fit inside the tpl_content() function.

Thoughts?