DokuWiki deployment notes

dokuwiki What is it?

whatever wiki engine （ Also known as wiki Software , Hereinafter referred to as engine ） Are used to support the creation of 、 Collaborative editing 、 Software that stores and uses hyperlinked documents . Editing is usually done through a web browser . Sometimes , The engine can be called knowledge management software .

DokuWiki It's open source wiki engine , To run on PHP In the environment .DokuWiki The program is small and powerful 、 flexible , Suitable for small and medium-sized team and individual website knowledge base management .

dokuwiki stay Windows The installation of the

Method 1 ： use XAMPP

I won't say the specific method , There are many tutorials online

My trouble is , The webpage reported many errors , And the layout is very strange . Trying all kinds of methods won't work , For example, change the template , Change profile , No matter how you try , It's all failures .

Put some pictures of failure ：

I wonder if it's a tool problem , Can you replace it with another one XAMPP Tools for ？

Method 2 ： use PHPstudy

Official website address ：https://www.xp.cn/

PHPStudy One click support LAMP、LNMP、FTP etc. 100 Multiple server management functions （ Official website said ）.

After downloading , Fool install .

start-up Apache perhaps Nginx

Click on the left 【 Website 】 You can see the port , Dexter 【 management 】–【 modify 】 You can modify the port .

next , Go to the website root directory （WWW Catalog ） Dexter 【 management 】–【 Open the root directory 】, hold dokuwiki copy to WWW Directory , decompression .

Get into dokuwiki You can see in the directory that there is a install.php

Access in a browser localhost:8081/dokuwiki/install.php, Simple configuration

After filling in, you can enter wiki The home page

If you set Chinese , It's like this

Create directories and pages

Create directories and pages . There are two ways , One is directly in pages Create folders and text files under the directory , One is through plug-ins , Operate on the web .

I am here page A folder is created under the directory “ The car ”, And in the “ The car ” A text file is created inside ： I am a car .txt

At this time, click the website map , You will find nothing under the car , Out of sight “ I am a car .txt”

in other words , Chinese namespace （ A namespace can be understood as a folder ） Text files named in Chinese cannot be displayed under .

Fortunately, this problem can be fixed .

Fix that the page named in Chinese cannot be displayed

Get into dokuwiki Install under directory inc Folder , open pageutils.php

1. hold utf8_encodeFN Function 2 Line comment out

   function utf8_encodeFN($file,$safe=true){
         
       global $conf;
       if($conf['fnencode'] == 'utf-8') return $file;
   
       if($safe && preg_match('#^[a-zA-Z0-9/_\-\.%]+$#',$file)){
         
           return $file;
       }
   
       if($conf['fnencode'] == 'safe'){
         
           return SafeFN::encode($file);
       }
       
      // $file = urlencode($file);
      // $file = str_replace('%2F','/',$file); chezi
       return $file;
   }
   

   13-14 Comment out

2. modify utf8_decodeFN function

   function utf8_decodeFN($file){
         
       global $conf;
       if($conf['fnencode'] == 'utf-8') return $file;
   
       if($conf['fnencode'] == 'safe'){
         
           return SafeFN::decode($file);
       }
       return $file;
       //return urldecode($file); cjy
   }
   

   The first 9 Line comment out , Add para 8 That's ok

How to install plug-ins

There are ways to install plug-ins 2 Kind of , One is online installation ; One is to download the plug-in package first , Then install it locally .

Let's start with the first method .

Log in as Administrator , Click management in the upper right corner , Then click extension manager .

Enter the name or keyword of the plug-in , Click the magnifying glass button .

If there is a match , It will show , Click what you want to install .

Whether the installation is successful or not , There are hints . For example, a failed picture ：

It may also be that you can't download , such as ：

In this case , Just find the download address , Try to download it .

With the installation package , Manual installation . Manually install 2 Methods , One is to decompress directly to dokuwiki\lib\plugins Catalog , Change the name of the folder if necessary （The base name of the plugin can be found in plugin.info.txt）; The other is to install through buttons , Here's the picture

Click Install manually , Then select the downloaded installation package （ Don't decompress ）, Click to install .

The plugin is recommended

According to the recommendation of netizens , There are a lot of them ,plugins Directory as follows （ Many of them are self-contained ）：

For each folder , You can go in and have a look , You can get a lot of information about this plug-in , For example, download address , Instructions , Configuration files, etc .

Add New Page

# General Plugin Info
base   addnewpage
author Benjamin Santalucia, Sam Wilson, Michael Braun, Gerrit Uitslag, Albert Chern
email  
date   2015-11-02
name   Add New Page
desc   Adds a "new page form" to any wiki page.
url    http://www.dokuwiki.org/plugin:addnewpage

Download address ：http://www.dokuwiki.org/plugin:addnewpage

After installing this plug-in , Users can create namespaces and pages through browser pages .

How to set it ？

Click on welcom Interface , Click again sidebar

This will show “ The theme does not yet exist ”, Click on the right “ Create this page ”, Input { {NEWPAGE}}, Save again , Just OK 了 .

indexmenu

base   indexmenu
author Samuele Tognini
email  [email protected].netsons.org
date   2020-07-31
name   Indexmenu Plugin
desc   Show a customizable and sortable index for a namespace
url    https://www.dokuwiki.org/plugin:indexmenu

Download address ： https://www.dokuwiki.org/plugin:indexmenu

This plug-in allows you to insert a fully customizable index or a list of pages starting from a specified namespace .

I think the most useful part of this plug-in is that it can add a navigation list in the sidebar .

Setup method ：

After installation , stay sidebar Add... At the end of the page
{ {indexmenu>:}}

effect ：

move

base   move
author Michael Hamann, Gary Owen, Arno Puschmann, Christoph Jähnigen
email  [email protected]-space.de
date   2018-04-30
name   Move plugin
desc   Move and rename pages and media files whilst maintaining the links.
url    http://www.dokuwiki.org/plugin:move

Download address ：http://www.dokuwiki.org/plugin:move

This plug-in allows you to move pages and namespaces containing media files , And automatically adjust all links and media references to these pages .

Be careful ： This plug-in moves files to DokuWiki In the data directory , And can automatically change many pages . Although the plug-in has been successfully tested , But in your case, there may always be something that doesn't work properly , And your wiki May be in an inconsistent state . This plug-in is quite new , In some cases, it may not behave correctly .

Please make a backup before using this plugin, especially if you plan to make larger changes!

Warning : This plug-in is not updated ACL The rules . for example , If you have one ACL The rules , This rule applies to a wiki The page is read protected , Then after moving the page , This rule will no longer have any effect .

In addition to renaming a page , This plug-in requires administrator privileges to use .

Usage method ： Log in as Administrator , Click on the “ management ”

Click on 【 Page move / rename 】

Click on Tree movement

Drag the directory directly . The buttons in the red box are prepared for renaming .

imgpaste

base   imgpaste
author Andreas Gohr
email  [email protected].de
date   2018-05-03
name   imgpaste plugin
desc   Add images via cut'n'paste in Chrome
url    http://www.dokuwiki.org/plugin:imgpaste

Download address ：http://www.dokuwiki.org/plugin:imgpaste

This plug-in allows you to insert pictures by simply pasting them into the editor . This is especially useful for inserting screenshots . Please note that this plug-in works in Chrome browser ,Opera ( from 15 Version start ) ,Firefox 52,Safari (iOS).

You can specify how the image name is constructed . You should ensure that the name of the construct is unique ( By using the current time ). except strftime wildcard , You can also use the following placeholders :

color

base   color
author Harald Hanche-Olsen
email  harald.hanche-[email protected].no
date   2018-10-12
name   color syntax plugin
desc   Write colored text in DokuWiki.
url    https://www.dokuwiki.org/plugin:color

Download address ：https://www.dokuwiki.org/plugin:color

effect ： It can display colored words

For example, edit box input ：

<color green>text</color>
<color blue/lightgrey>text</color>
<color #FF0000>text</color>
<color /#FFff00>text</color>
<color rgb(80%,0%,0%)/rgb(100%,80%,100%)>text</color>
<color hsl(120,100%,30%)/hsl(180,50%,90%)>text</color>

<color #008080> Green onions </color>、<color #ED6F00> Orange... Orange </color>、<color #BFAA15> Banana yellow </color>、
<color #FF00FF> Pink </color>、<color #0000FF> Blue </color>、<color #FF0000> Red </color>、
<color #008000> green </color>、<color #5F00BD> violet </color>、<color #FF9900> Orange yellow </color>、
<color #000000> black </color>、<color #808080> silvery </color>、<color #FF8080> Flat peach </color>、
<color #66CCFF> sky blue </color>、<color #66FFCC> Mint </color>、<color #BA0033> Jujube </color>、
<color #000080> Navy Blue </color>、<color #FF4E00> Orange red </color>、<color #7FB80E> Turquoise </color>、
<color #E54C4C> Light Rouge </color>、<color #D6006F> Peony red </color>、<color #534948> Pigeon feather grey </color>、
<color #AE35FF> lilac colour </color>、<color #2A5CAA> Glazed blue </color>、<color #800080> Violet </color>、
<color #8567B6> Edo purple </color>、<color #700000> Brown </color>、<color #897B52> Brown Gold </color>、
<color #FFCE00> golden </color>.

 You can also enter the hexadecimal code of web page color by yourself （Hex triplet）, Deploy the desired text color . for example ：
<color #FF84BA> Pink </color>、<color #58C3E0> Water blue </color>、<color #E85700> Big orange </color>、
<color #EEDD65> Cream yellow </color>、<color #983333> Deep Rouge </color> etc. .

effect ：

syntaxhighlighter4

base   syntaxhighlighter4
author CrazyMax
email  [email protected].dev
date   2020-05-13
name   SyntaxHighlighter4 Plugin
desc   Alternative to GeSHi server-side code highlighting with client-side SyntaxHighlighter 4 by Alex Gorbatchev
url    http://www.dokuwiki.org/plugin:syntaxhighlighter4

Download address ：https://www.dokuwiki.org/plugin:syntaxhighlighter4

effect ： Code highlighting

The author also gives examples , Enter

<sxh php; highlight: [11-15]>
    /** * [Custom event handler which performs action] * * @param Doku_Event $event event object by reference * @param mixed $param [the parameters passed as fifth argument to register_hook() when this * handler was registered] * @return void */

    public function handle_metaheader(Doku_Event &$event, $param) {
    
        // Add SyntaxHighlighter theme.
        $event->data['link'][] = array('rel' => 'stylesheet',
            'type' => 'text/css',
            'href' => DOKU_BASE . 'lib/plugins/syntaxhighlighter4/dist/'.$this->getConf('theme'),
        );

        // Register SyntaxHighlighter javascript.
        $event->data["script"][] = array("type" => "text/javascript",
            "src" => DOKU_BASE . "lib/plugins/syntaxhighlighter4/dist/syntaxhighlighter.js",
            "_data" => ""
        );
    }
</sxh>

design sketch ：

discussion

base   discussionauthor Michael Hamann, Gerrit Uitslag, Gina Häussge, Christopher Smith, Michael Klier, Esther Brunner, Matthias Schulteemail  [email protected]-space.dedate   2020-09-24name   discussion plugindesc   Provides discussion funtionality for wiki pagesurl    https://dokuwiki.org/plugin:discussion

effect ： For you Wiki Add comment function to the page . If you don't want to give ordinary users the right to edit pages , However, users are still expected to provide notes , Then doing so can distinguish the page content from the discussion .

Download address and usage ： https://www.dokuwiki.org/plugin:discussion

At the end of the page , add to ~~DISCUSSION~~ To start the discussion .

To close the discussion , Use ~~DISCUSSION:off~~

If you want to show existing discussions , But I don't want to allow new comments / reply , Use ~~DISCUSSION:closed~~

Let's try .

After saving, you will see ：

Use ~~DISCUSSION:off~~ After closing , The comment content and comment box are gone , Nothing seems to have happened .

Use ~~DISCUSSION:closed~~ The situation of ：

codemirror

base   codemirrorauthor Albert Gasset (fix by CosmoCode)email  [email protected].orgdate   2020-09-05name   CodeMirror plugindesc   Editor with syntax highlightingurl    https://github.com/albertgasset/dokuwiki-plugin-codemirror

Download address ：https://github.com/albertgasset/dokuwiki-plugin-codemirror

effect ： Syntax coloring the text in the edit box

for example ：

tag

base   tagauthor Michael Hamann, Gina Häussge, Christopher Smith, Michael Klier, Esther Brunneremail  [email protected]-space.dedate   2020-12-02name   Tag Plugindesc   tag wiki pagesurl    https://www.dokuwiki.org/plugin:tag

effect ： Tag the page .

Usage example ：{ {tag> gentle beautiful wisdom }}

You can also search for tags , Count label , Display a list of pages that contain some tags, and so on .

Reference resources ：https://www.dokuwiki.org/plugin:tag

Here's a reminder ： It is not recommended that Tag Used as a classification , And more as 【 impression 】 Use ！

wrap

base     wrap
author   Anika Henke
email    [email protected].org
date     2018-04-22
name     Wrap Plugin
desc     Universal plugin which combines functionalities of many other plugins. Wrap wiki text inside containers (divs or spans) and give them a class (choose from a variety of preset classes), a width and/or a language with its associated text direction.
url      https://www.dokuwiki.org/plugin:wrap
#syntax See example.txt

Universal plug-ins , It combines the functions of many other plug-ins . Pack in containers wiki Text (div or span) And give them a class ( Choose from various preset classes )、 A width and / Or a language with relevant text directions .

I like it because it can make the text more fancy , Ha ha ha .

<WRAP tip>tip</WRAP>
<WRAP important>important</WRAP>
<WRAP alert>alert</WRAP>
<WRAP download>download</WRAP>
<WRAP todo> todo </WRAP>

effect ：

edittable

base    edittable
author  Andreas Gohr
email   [email protected].de
date    2020-11-09
name    EditTable plugin
desc    Provide a custom editor for tables
url     https://www.dokuwiki.org/plugin:edittable

Download address ：https://www.dokuwiki.org/plugin:edittable

effect ： You can edit the table friendly on the page .

for example ：

Click on “ edit ”

For those who are not familiar with editing tables with text , It's a good tool .

filelist

base   filelist
author Gina Häußge, Dokufreaks
email  [email protected].net, [email protected].org
date   2020-09-27
name   Filelist Plugin
desc   Lists files matching a given glob pattern.
url    https://www.dokuwiki.org/plugin:filelist

effect ： The file list plug-in provides a syntax , Wildcard based glob Mode selected links and sorted file list added to wiki page , This allows file lists that dynamically contain arbitrary file system locations and media namespaces . Use additionalfilename command , Users can also add a file link from anywhere in the text , Download link for automatically saving the latest uploaded software version .

give an example ： Input { {filelist>lib/images/*&style=list&direct=1}}

effect ：

【End】