User Tools

Site Tools

Trace: • dokuwiki_notes
dokuwiki_notes

Table of Contents

tasks

search the wiki

Install ShortcutKey plugin (https://www.dokuwiki.org/plugin:shortcutkey). Then use 's' to focus on search box.

tags | search field, put the curson on the search bar

how to write question and answers

tags | qna, Q&A

You can use 

:?: Question \\
:!: Answer

It will render as

:?: Question
:!: Answer

It also works with lists. For example 

  * :?: Question
  * :!: Answer

will render as

  • :?: Question
  • :!: Answer

See also:

mediawiki vs. dokuwiki

tags | missing features

I miss the following features in dokuwiki when compared to mediawiki

  1. The sections are numbered in mediawiki but they are not numbered in dokuwiki.
  2. The edit button is at the bottom of the section in dokuwiki but it is at the top in mediawiki.
  3. When you edit a section in mediawiki, all the subsections will be part of the edit. But that is not the case in dokuwiki. This is useful if you want to rearrange subsections within a section
    1. work around: edit a whole section
  4. You can't have links in section headings

convert mediawiki page to dokuwiki

pandoc -f mediawiki -t dokuwiki --shift-heading-level-by=-1 mw.txt -o dk.txt

Q. Why –shift-heading-level-by=-1?

A. The section levels are preserved. For example 

$ cat mw.txt
==== foo ====

$ pandoc -f mediawiki -t dokuwiki mw.txt
=== foo ===

$ pandoc --shift-heading-level-by=-1 -f mediawiki -t dokuwiki mw.txt
==== foo ====

See also:

tags | section headings, header levels, mediawiki to dokuwiki change header level

reference urls

check the version of dokuwiki instance

Ref:- https://www.dokuwiki.org/faq:version

tags | check dokuwiki version running

Tag plugin

  • The plugin version 2022-10-02 is incompatible with dokuwiki 0.0.20180422.a-2.1. For example, if I add the following line to the bill_pay_setup page
    {{tag>tag1 tag2 tag3}}

I am getting 

022/12/06 16:38:23 [error] 2076452#2076452: *82 FastCGI sent in stderr: "PHP message: PHP Fatal error:  Uncaught Error: Class 'dokuwiki\Extension\Event' not found in /var/lib/dokuwiki/lib/plugins/tag/helper.php:227
Stack trace:
#0 /var/lib/dokuwiki/lib/plugins/tag/helper.php(169): helper_plugin_tag->tagLink()
#1 /var/lib/dokuwiki/lib/plugins/tag/syntax/tag.php(80): helper_plugin_tag->tagLinks()
#2 /usr/share/dokuwiki/inc/parser/renderer.php(111): syntax_plugin_tag_tag->render()
#3 /usr/share/dokuwiki/inc/parserutils.php(654): Doku_Renderer->plugin()
#4 /usr/share/dokuwiki/inc/parserutils.php(130): p_render()
#5 /usr/share/dokuwiki/inc/parser" while reading upstream, client: 68.198.191.3, server: www.kamaraju.xyz, request: "GET /dk/bill_pay_setup HTTP/1.1", upstream: "fastcgi://unix:/var/run/php/php7.4-fpm.sock:", host: "www.kamaraju.xyz", referrer: "https://www.kamaraju.xyz/dk/bill_pay_notes"
2022/12/06 16:38:23 [error] 2076452#2076452: *82 FastCGI sent in stderr: "utils.php(83): p_cached_output()
#6 /usr/share/dokuwiki/inc/html.php(293): p_wiki_xhtml()
#7 /usr/share/dokuwiki/inc/Action/Show.php(33): html_show()
#8 /usr/share/dokuwiki/inc/template.php(98): dokuwiki\Action\Show->tplContent()
#9 /usr/share/dokuwiki/inc/events.php(111): tpl_content_core()
#10 /usr/share/dokuwiki/inc/events.php(256): Doku_Event->trigger()
#11 /usr/share/dokuwiki/inc/template.php(83): trigger_event()

Upgrading from 

$ dpkg -l dokuwiki | grep ^ii
ii  dokuwiki       0.0.20180422.a-2.1 all          standards compliant simple to use wiki

to 

$ dpkg -l dokuwiki | grep ^ii
ii  dokuwiki       0.0.20220731.a-1 all          standards compliant simple to use wiki

fixed the issue

struct plugin

refnotes plugin

google search | citing sources

related links

table with minimum column width

Use 

<WRAP group><WRAP column>
^ Heading ^ Heading ^
| cell data | cell data |
</WRAP></WRAP>

For example 

<WRAP group><WRAP column>
^ Heading ^ Heading ^
| cell data | cell data |
</WRAP></WRAP>

will render as

Heading Heading
cell data cell data

while 

^ Heading ^ Heading ^
| cell data | cell data |

will render as

Heading Heading
cell data cell data

Ref:- https://forum.dokuwiki.org/d/15099-creating-variable-width-shrink-to-fit-columns → wizgeek's answer

tags | reduce column width

table as a list item

tags | table inside a list

To get

  • tables
    • table 1
      foo foo
      foo foo

    • tabel 2

      bar bar
      bar bar

    • blah blah
      blah blah

use 

  * tables
    * table 1 <WRAP>
^ foo ^ foo ^
| foo | foo |
</WRAP>
    * tabel 2 <WRAP>
^ bar ^ bar ^
| bar | bar |
</WRAP>
    * <WRAP>
^ blah ^ blah ^
| blah | blah |
</WRAP>

Ref: https://forum.dokuwiki.org/d/19773-how-can-a-table-be-indented-within-a-list

remove extra line in lists inside table cells

tags | lists inside table cells wrap plugin

When the WRAP plugin is used to create lists inside table cells, an extra line is added at the end of the list. To remove it, add the following to /etc/dokuwiki/userstyle.css . 

div.plugin_wrap ul { margin-bottom: 0px; }

The new setting will be picked up automatically when the page is refreshed.

multiple lines in table cell

Install the wrap plugin and do something like 

^ days ^ months ^
| <WRAP>
  * Sunday
  * Monday
</WRAP> | <WRAP>
  * January
  * February
  * March
</WRAP> |
| <WRAP>
  * Tuesday
  * Wednesday
</WRAP> | <WRAP>
  * April
  * May
</WRAP> |

which will give

days months
  • Sunday
  • Monday
  • January
  • February
  • March
  • Tuesday
  • Wednesday
  • April
  • May

Ref:-

indented paragraph

If you only need one tab, install the “WRAP” Plugin (See http://dokuwiki.org/plugin:wrap), and then use the following syntax: 

<WRAP indent>your text</WRAP>

Example:

foo 1

  • bar 1
  • bar 2

foo 2

  • bar 3
  • bar 4

tags | insert tab

double dashes in monospaced text

Use ''%%--%%'' to render --.

Compare this to ''--'' which renders as a single dash –

Ref:- https://www.dokuwiki.org/wiki:syntax#no_formatting

Extension:- To display an option such as --skip-string-normalization, use ''%%--skip-string-normalization%%''.

tags | remove formatting

sitemap

http://www.kamaraju.xyz/dk/start?do=sitemap

search within a namespace

To search pages within a namespace, prefix @ or ns: to the namespace. To not search pages within a namespace, prefix ^ or -ns: to the namespace.

Examples: 

dividend yield ns:diary

will search for 'dividend yield' in the 'diary' namespace

https://www.dokuwiki.org/search#search_within_a_namespace

useful plugins

plugins I am exploring

plugins I came across

https://philip-p-ide.uk/doku.php/blog/articles_on_writing/wiki_farm_01 mentioned


https://www.dokuwiki.org/tips:book mentions two plugins that are useful for creating books.




https://diyfuturism.com/index.php/2018/01/01/how-to-set-up-a-personal-wiki-with-configuration-for-common-use-cases-like-recipes-and-journaling/ talks about TemplatePageName plugin

conflicting plugins

buggy plugins

list of installed plugins

syntaxplugins

adminplugins

Ref:- https://www.dokuwiki.org/plugin:info

issues reported by me

include code in ordered lists

Put the <code> tag on the same line of the item. For example

  • foo 
    bar

as opposed to

  • foo 
bar

Useful documentation

Questions to look into

  • Is it possible to persist the breadcrumbs across user sessions? For example, the breadcrumbs are lost if I close the chrome browser and reopen it. Is it possible to preserve them even in such cases?

You can use [[:ns:]]. For example [[:diary:]] will render as diary.

Ref:-

directory layout in debian

dokuwiki root /usr/share/dokuwiki
wiki data /var/lib/dokuwiki/data
configuration /etc/dokuwiki

my symlinks

  • /var/www/wiki → /usr/share/dokuwiki

Ref:- https://wiki.debian.org/DokuWiki#Specificities_of_the_Debian_package

pages in this wiki

dummy

  • You can add ?do=export_xhtmlbody to any DokuWiki link to view the body of a DokuWiki document as XHTML
dokuwiki_notes.txt · Last modified: 2024/10/25 20:42 by raju