• Home
  • History
  • Annotate
Name Date Size #Lines LOC

..29-Nov-2022-

conf/H12-May-2021-7243

images/H12-May-2021-

lang/en/H12-May-2021-5133

mermaid/H12-May-2021-58,20653,958

script/H12-May-2021-22995

syntax/H12-May-2021-1,374632

LICENSEH A D11-May-202117.6 KiB341281

README.mdH A D11-May-20215.3 KiB155115

action.phpH A D11-May-202118.2 KiB656406

dokuwiki_plugin_dirtylittlehelper.txtH A D11-May-202110.7 KiB391271

plugin.info.txtH A D11-May-2021297 87

script.jsH A D11-May-202131.6 KiB977694

style.cssH A D11-May-20215.5 KiB270202

README.md

1
2
3# Dokuwiki-DirtyLittleHelper
4
5dirtylittlehelper (dlh) is as plugin for  [Dokuwiki](https://www.dokuwiki.org).
6
7## THANK YOU / credits
8@turnermm: [overlay plugin](https://github.com/turnermm/Dokuwiki-Nav-Overlay) - the base I began with
9@samfisch: [dokubook template](https://github.com/samfisch/dokuwiki-template-dokubook) - here I found the tree
10@lisps: [linksuggest plugin](https://github.com/lisps/plugin-linksuggest/) - I copied it :-)
11@giterlizzi [bootstrap3 template](https://github.com/giterlizzi/dokuwiki-template-bootstrap3) - there I found the inspiration for the admin menu
12@jakob1111 [flowcharts plugin](https://github.com/jakob1111/dokuwiki-plugin-flowcharts/) - the base for mermaid integration
13@mermaid-js [mermaid-live-editor](https://github.com/mermaid-js/mermaid-live-editor) - the mermaid live editor
14
15
16## why? / history
17I wanted a better way for inserting wiki-internal-links in the editor. After some searching and probing I found the way that fits best for me: with "bureaucracy" and "struct" plugin  you can build nice lookups for namespaces...
18
19Then I took the "overlay" plugin and modified it for my needs. After a while I thought that it would be cool not to click on a button to have the search input and the insert button.
20
21Some jQuery later: it works. After the editor ist opened the dlh-page is loaded in the overlay, then the elements are transferred in a new line under the toolbar in the editor. The overlay is not shown anymore - but it's still there.
22
23Building and integrating flow-charts with mermaid: integrated. And dlh ships a mermaid live editor (the first chart in the wiki-editor is now transferred to the live editor; the rest: copy and paste).
24
25And i needed / wanted a quick-admin-menu -> added (inspired by bootstrap3 template)
26
27And sometimes the wiki should be wider - especially when editing and with "advanced config" plugin - done ...that means that after install of this plugin your wiki can look a bit different (thats life).
28
29Then i thought it would be nice to have a tree on the left side like "dokubook" template  -> added syntax for the tree.
30
31The tree on the left is not always needed - added syntax for "no sidebar"...
32
33I like comments -> syntax added
34
35right now it works fine...
36
37# what can dlh do four you?
38
39## main feature - page-search in the editor
40#### you need:
41[bureaucracy-plugin](https://www.dokuwiki.org/plugin:bureaucracy)
42[struct-plugin](https://www.dokuwiki.org/plugin:bureaucracy)
43
44#### let's go
45- install the both plugins
46- create a struct-scheme
47- create at least one field in this scheme
48-- typ "page"
49-- config "usetitles" > thats better
50-- config "autocomplete" - "namespace" > put your namespace here
51- create the dokuwiki page that is configured  "plugin»dirtylittlehelper»page"
52````
53~~NOCACHE~~
54~~NOTOC~~
55=== DLH ===
56<form>
57action script dummy.php
58struct_field "scheme_name.field_name_1" !
59struct_field "scheme_name.field_name_2" !
60</form>
61````
62- open the editor and smile
63
64## dlh tree
65```` <dlh.tree>````
66put it in your sidebar page and be happy
67if there would be several trees -> only the first one is displayed
68
69```` <dlh.notree>````
70no tree will be rendered
71
72```` <dlh.forcetree>````
73only this tree will be rendered (overrides ````notree````)
74works only once
75
76
77
78## sidebar
79```` <dlh.nosb> ````
80The sidebar will not be shown (css) - beware that the sidebar / tree will be generated.
81
82```` <dlh.togglesb> ````
83there will be a button at the top left of the sidebar to toggle it
84with
85
86```` <dlh.hidesb ````
87you can hide the sidebar
88
89
90## mermaid
91````
92<dlh.mm>
93graph LR
94DOKUWIKI----DLH
95</dlh.mm>
96````
97When you click the mermaid live editor you can follow the links to syntax etc.
98
99## comments
100````
101<dlh.*> this one line comment will only be seen in the editor </dlh.*>
102
103<dlh.*>
104this
105multi
106line
107comment will also only be seen in the editor
108</dlh.*>
109````
110
111## div
112
113```` <dlh.div.html[ id="" class="" style=""...]> Your html content </dlh.div.html>````
114will build a html div like ````<html><div>Your html content</div></html>````
115
116```` <dlh.div.wiki [ id="" class="" style=""...]> **Your** WIKI __content__ </dlh.div.wiki>````
117will build a div around your wiki code  like ````<html><div></html>**Your** WIKI __content__ <html></div></html>````
118
119## table
120````
121<dlh.table.html[ id="" class="" style=""...]>
122  <caption>your caption</caption>
123  <tr>
124    <th>tablehead a</th>
125    <th>tablehead b</th>
126  </tr>
127  <tr>
128    <td> cell with text </td>
129    <td> amnother cell </td>
130  </tr>
131<dlh.table.html>
132````
133
134is for pure html and like ```` <dlh.div.wiki> ```` you can build a table around wiki content
135
136````
137<dlh.table.wiki [ id="" class="" style=""...]>
138  <dlh.caption.wiki> **wiki caption content** </dlh.caption.wiki>
139  <dlh.tr.wiki>
140    <dlh.th.wiki> table head __wiki__ syntax </dlh.th.wiki>
141    <dlh.th.wiki> **another** table head __wiki__ syntax </dlh.th.wiki>
142  </dlh.tr.wiki>
143  <dlh.tr.wiki>
144    <dlh.td.wiki> call a plugin or some other cool stuff </dlh.th.wiki>
145    <dlh.td.wiki> **wiki syntax here** </dlh.th.wiki>
146  </dlh.tr.wiki>
147</dlh.table.wiki>
148
149````
150
151
152## BEWARE !
153This plugin is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
154This plugin is generally made for MY personal needs.
155