Differences

This shows you the differences between two versions of the page.

--- manual [2023-09-14 15:01] – 2401:4900:1c16:756c:492:7656:1d4b:8a6
+++ manual [2024-10-16 17:24] (current) – Aleksandr
@@ Line 1: / Line 1: @@
 ====== DokuWiki Manual ======
-The manual is intended to be the extended resource for all standard questions on using DokuWiki. It includes information useful for "standard" users up to administrators who want to configure and run their own wiki installation.
+The manual is intended to be the extended resource for all standard questions on using DokuWiki. It includes information useful for "standard" users and administrators who want to configure and run their own wiki installation.
 Pages should start with a general description of a feature and how to use it, then go into detail about how to configure it.
+If you can't find what you're looking for here, be sure to use the search.
+===== 1. General =====
-If you can't find what you're looking for here, be sure to use the search.
+  * [[:dokuwiki|What is DokuWiki?]]
+  * [[faq:support|How Do I Get Support]]
+  * [[:screencast|Learn by Video: Screencast Tutorials]]
+  * [[:faq|Frequently Asked Questions (FAQ)]]
+  * [[:tips|Tips and Tricks for DokuWiki]]
+===== 2. Installing DokuWiki =====
+  * [[:Requirements]]
+  * [[:install|Installation]]
+  * [[:changes|DokuWiki Releases]]
+  * [[:faq|Troubleshooting]]
+===== 3. Using DokuWiki =====
+==== 3.1 Navigation through DokuWiki Pages ====
+  * [[:main_window|The Main Window]]
+  * [[:page|Wiki Pages]]
+  * [[:Namespaces]]
+  * [[:wiki:syntax#links|Different types of links:]]
+    * [[:wiki:syntax#internal|internal]]
+    * [[;wiki:syntax#interwiki|interwiki]]
+    * [[:wiki:syntax#external|external]] (& email)
+    * [[:wiki:syntax#windows_shares|windows shares]]
+  * [[:search|Using the Search function]]
+  * [[:index|Sitemap]] (aka. Index)
+  * [[:recent changes|Recent changes]]
+  * [[:attic|Older page revisions]]
+  * [[:syndication|RSS and ATOM feeds]]
+  * [[:export|Export Pages]]
+==== 3.2 The Edit Window ====
+  * [[:edit_window|The Edit Window]]
+  * [[:toolbar|Quickbuttons for formatting markup]]
+  * [[:summary|The Edit Summary]]
+  * [[:Edit Window#Minor Changes]]
+==== 3.3 Editing DokuWiki Pages ====
+  * [[:editing|Page Editing]]
+  * [[:section_editing|Section Editing]]
+  * [[:wikitext|View the wiki source text]]
+  * [[:wiki:syntax|Formatting syntax]]
+    * [[:wiki:syntax#basic_text_formatting|Basic text formatting (typefaces, footnotes, ..)]]
+    * [[:wiki:syntax#links|Links]]
+    * [[:wiki:syntax#sectioning|Sectioning]]
+    * [[:wiki:syntax#media_files|Images, uploaded files]]
+    * [[:wiki:syntax#lists|Lists (ordered and unordered)]]
+    * [[:wiki:syntax#tables|Tables]]
+    * [[:wiki:syntax#Text Conversions|Smileys, Abbreviations and Typography]]
+    * [[:wiki:syntax#No Formatting|Nonparsed blocks (e.g. to display code)]]
+    * [[:plugins?plugintype=1&pluginsort=^c#extension__table|More Formatting via Plugins ⇒]]
+  * [[:namespace_templates|Using Page Templates]]
+  * [[:tips:Good Content]]
+  * [[:tips:Good Style]]
+  * [[:recent_changes#Difference between 'recent changes' and 'old revisions']]
+  * [[:locking|How page locking works]]
+  * [[:draft|Automatic Draft Saving]]
+==== 3.4 Media Files ====
+  * [[:images|Image- and Mediahandling]]
+  * [[:fullscreen mediamanager|Fullscreen Media Manager]]
+  * [[:media manager|The Media Manager Popup]]
+  * [[:mime|MIME configuration]]
+  * [[:exif|EXIF and IPTC support]]
+==== 3.5 Non-Anonymous Wikis ====
+  * [[:login|Registering and Logging in]]
+  * [[:subscription|Email Subscriptions]]
+===== 4. DokuWiki Administration =====
+  * [[:admin_window|The admin window]]
+  * [[:config|Configuration]]
+    - [[:rewrite|Nice URLs through rewriting]]
+    - [[:faq:mail|Mail Sending]]
+  * [[:permissions|Let's talk about permissions]]
+    - [[:acl|Access Control with ACL]]
+    - [[:auth|Authentication methods]]
+  * [[:tips:maintenance|Maintenance]]
+  * [[:antispam|Anti-Spam Features]]
+  * [[:seo|Search Engine Optimization]]
+  * [[:cli|Command Line Tools]]
+  * [[:faq:backup|Backup]]
+  * [[:faq:servermove|Server Migration]]
+===== 5. Adapting DokuWiki to Your Needs =====
+  * [[:plugins|Installing a plugin]]
+  * [[:Template|Using templates to alter the looks of your wiki]]
+    - [[plugin:styling|Configuring template styles]]
+    - [[:css|Custom Styles]]
+  * [[:Localization|Make DokuWiki talk your language]]
+  * [[:devel:auth plugins|How to implement your own authentication plugin]]
+===== 6. Specific Use Cases =====
+  * [[:tips:blogging|DokuWiki for Blogging]]
+  * [[:tips:cms|DokuWiki as a lightweight CMS]]
+  * [[solutions:writing|DokuWiki for Document Writing]]
+  * [[farms|DokuWiki Farms]]
+===== 7. Developing DokuWiki =====
+==== For hands-on developers ====
+  * **[[:development|Dokuwiki's Development Manual]]** \\       Among others:
+    * [[devel:plugins|Plugin Development]]
+    * [[devel:templates|Template Development]]
+  * **Browse and search the code base**
+    * [[https://github.com/dokuwiki/dokuwiki|DokuWiki's Github Repository]] (core)
+    * See also: [[:devel:repos|Sundry Code Repositories]]
+    * [[https://xref.dokuwiki.org|XRef Cross Reference]] (core)
+    * **Search in core and extensions:** [[https://codesearch.dokuwiki.org/|OpenGrok Code Search]]
+  * **See also**
+    * [[changes|DokuWiki Releases & Changelog]]
+    * [[devel:releases|Detailed Changelog for Developers]]
+    * A look behind the curtains: \\ [[devel:patreonblog|Andi's blog posts on Patreon]]
+==== Commission or offer developments ====
-  - [[dokuwiki|What is DokuWiki?]]
+  * [[:bounties|DokuWiki Bounty Program]]
-  - Installing DokuWiki
+  * [[:faq:support#professional_support_and_services|Professional Support and Services]]
-    - [[Requirements]]
-    - [[install|Installation]]
-    - [[faq|Troubleshooting]]
-  - Using  DokuWiki
-    - [[screencast|Learn by Video: Screencast Tutorials]]
-    - [[main_window|The Main Window]]
-    - Navigation through DokuWiki Pages
-      * [[page|Pages]]
-      * [[Namespaces]]
-      * [[wiki:syntax#links|Different types of links:]] [[wiki:syntax#internal|internal]], [[wiki:syntax#interwiki|interwiki]], [[wiki:syntax#external|external]], [[wiki:syntax#e-mail|e-mail]], [[wiki:syntax#windows_shares|windows shares]]
-      * [[search|Using the Search function]]
-      * [[index|Sitemap]] (aka. Index)
-      * [[recent changes|Recent changes]]
-      * [[attic|Older page revisions]]
-      * [[syndication|RSS and ATOM feeds]]
-      * [[export|Export Pages]]
-    - [[edit_window | The Edit Window]]
-      * [[toolbar|Quickbuttons for formatting markup]]
-      * [[summary|The Edit Summary]]
-      * [[Edit Window#Minor Changes]]
-    - [[editing | Editing DokuWiki Pages]]
-      * [[section_editing|Section Editing]]
-      * [[wikitext|View the wiki source text]]
-      * [[wiki:syntax|Formatting syntax]]
-        * [[wiki:syntax#basic_text_formatting|Basic text formatting (typefaces, footnotes, ..)]]
-        * [[wiki:syntax#links|Links]]
-        * [[wiki:syntax#sectioning|Sectioning]]
-        * [[wiki:syntax#images_and_other_files|Images, uploaded files]]
-        * [[wiki:syntax#lists|Lists (ordered and unordered)]]
-        * [[wiki:syntax#tables|Tables]]
-        * [[wiki:syntax#Text Conversions|Smileys, Abbreviations and Typography]]
-        * [[wiki:syntax#No Formatting|Nonparsed blocks (e.g. to display code)]]
-        * [[wiki:syntax#embedding_html_and_php|Embedded HTML and PHP code]]
-        * [[plugins?plugintype=1#extension__table|Syntax plugins]]
-      * [[namespace_templates|Using Page Templates]]
-      * [[tips:Good Style]]
-      * [[recent_changes#Difference between 'recent changes' and 'old revisions']]
-      * [[locking|How page locking works]]
-      * [[draft|Automatic Draft Saving]]
-    - Media Files
-      * [[images|Image- and Mediahandling]]
-      * [[fullscreen mediamanager|Fullscreen Media Manager]]
-      * [[media manager|The Media Manager Popup]]
-      * [[mime|MIME configuration]]
-      * [[exif|EXIF and IPTC support]]
-    - Non-Anonymous Wikis
-      * [[login|Registering and Logging in]]
-      * [[subscription|Email Subscriptions]]
-    - [[css|Small Style Guide]]
-  - DokuWiki Administration
-    - [[admin_window|The admin window]]
-    - [[config|Configuration]]
-      - [[rewrite|Nice URLs through rewriting]]
-    - [[permissions|Let's talk about permissions]]
-      - [[acl|Access Control with ACL]]
-      - [[:auth|Authentication methods]]
-    - [[tips:maintenance|Maintenance]]
-    - [[antispam|Anti-Spam Features]]
-    - [[cli|Command Line Tools]]
-    - [[faq:backup|Backup]]
-    - [[faq:servermove|Move Server]]
-  - Adapting DokuWiki to Your Needs
-    - [[plugins|Installing a plugin]]
-    - [[:Template|Using templates to alter the looks of your wiki]]
-    - [[devel:css|A matter of style with CSS]]
-    - [[Localization|Make DokuWiki talk your language]]
-    - [[devel:authentication_backends|How to implement your own authentication back end]]
-    - [[development|The Development Manual]]
-    - [[bounties|DokuWiki Bounty Program]]
-  - Some details on specific requirements
-    - [[seo|DokuWiki and Search Engines]] aka. SEO
-    - [[tips:blogging|Using DokuWiki for Blogging]]
-    - [[tips:cms|Using DokuWiki as a lightweight CMS]]