DokuWiki

It's better when it's simple

User Tools

Site Tools


namespaces

Differences

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

Link to this comparison view

Both sides previous revisionPrevious revision
Next revision
Previous revision
namespaces [2017-09-22 17:29] – old revision restored (2017-09-22 09:31) bactramnamespaces [2024-02-26 13:38] (current) – [Namespace Default Linking] Removed HTMl spam bartv
Line 1: Line 1:
- 
 ===== Creating Namespaces ===== ===== Creating Namespaces =====
  
Line 6: Line 5:
 All namespaces used in your pagename that don't exist already will be created by DokuWiki automatically. All namespaces used in your pagename that don't exist already will be created by DokuWiki automatically.
  
-A namespace can be created in the media manager after having selected a file on the local computer and adding a ''name:'' (of namespace wanted) just before the media file name and then clicking  ''upload''. This will create on the fly the namespace (folder) for the file media, visible after a refresh of the windows. +A namespace can be created in the media manager after having selected a file on the local computer and adding a ''name:'' (of namespace wanted) just before the media file name and then clicking ''upload''. This will create on the fly the namespace (folder) for the file media, visible after a refresh of the windows.
  
-In DokuWiki pages are created as in every other wiki. Simply create a link to a non existing page, follow this link, and click on Create this page. See also [[.:page#create_a_page|Adding pages]].+In DokuWikipages are created as in every other wiki. Simply create a link to a non existing page, follow this link, and click on Create this page. See also [[.:page#create_a_page|Adding pages]].
  
-^  Examples:  ^^ +^  Examples:                                                                                                                                                                                                                                                                                                                                                                      || 
-|example\\ .example\\ .:example|refers to the page "example" in the **current** namespace.| +| example\\ .example\\ .:example          | refers to the page "example" in the **current** namespace.                                                                                                                                                                                                                                                                             
-|:example|refers to the page "example" in the **root** namespace.| +| :example                                | refers to the page "example" in the **root** namespace.                                                                                                                                                                                                                                                                                
-|..example\\ ..:example\\ .:..:example|refers to the page "example" in the **parent** namespace| +| ..example\\ ..:example\\ .:..:example   | refers to the page "example" in the **parent** namespace                                                                                                                                                                                                                                                                               
-|wiki:example|refers to the page "example" in the namespace "wiki". The namespace "wiki" is located **beneath the root** namespace.| +| wiki:example                            | refers to the page "example" in the namespace "wiki". The namespace "wiki" is located **beneath the root** namespace.                                                                                                                                                                                                                  
-|ns1:ns2:example\\ :ns1:ns2:example|refers to the page "example" in the namespace ns2. The namespace ns2 is located beneath the namespace ns1; the namespace ns1 is located **beneath the root** namespace.| +| ns1:ns2:example\\ :ns1:ns2:example      | refers to the page "example" in the namespace ns2. The namespace ns2 is located beneath the namespace ns1; the namespace ns1 is located **beneath the root** namespace.                                                                                                                                                                
-|.ns1:ns2:example\\ .:ns1:ns2:example|refers to the page "example" in the namespace ns2. The namespace ns2 is located beneath the namespace ns1; the namespace ns1 is located **beneath the current** namespace.| +| .ns1:ns2:example\\ .:ns1:ns2:example    | refers to the page "example" in the namespace ns2. The namespace ns2 is located beneath the namespace ns1; the namespace ns1 is located **beneath the current** namespace.                                                                                                                                                             
-|..ns1:ns2:example\\ ..:ns1:ns2:example|refers to the page "example" in the namespace ns2. The namespace ns2 is located beneath the namespace ns1; the namespace ns1 is located **beside the current** namespace (i.e. both ns1 and the current namespace are beneath the same parent namespace, wherever according to the root namespace this parent may be located itself).| +| ..ns1:ns2:example\\ ..:ns1:ns2:example  | refers to the page "example" in the namespace ns2. The namespace ns2 is located beneath the namespace ns1; the namespace ns1 is located **beside the current** namespace (i.e. both ns1 and the current namespace are beneath the same parent namespace, wherever according to the root namespace this parent may be located itself).  
-|.ns1:ns2:\\ .:ns1:ns2:|refers to the page "start" in the namespace ns2. The namespace ns2 is located beneath the namespace ns1; the namespace ns1 is located beneath the current namespace.\\ \\ (The default page can be named something other than "startby adjusting the [[config:startpage]] configuration setting.)+| .ns1:ns2:\\ .:ns1:ns2:                  | refers to start page of the namespace ns2. The namespace ns2 is located beneath the namespace ns1; the namespace ns1 is located beneath the current namespace.\\ \\ Please refer to [[#Namespace Default Linking]] below how the start page is determined | 
 +| ~example\\ ~:example                    | refers to the page "example", using the current page as a namespace. Eg. if used on the page "foo:bar", the link will refer to "foo:bar:example"This is an effective way of creating sub-namespaces from existing pages.                                                                                                             |
  
 :!: Gotcha: The syntax for relative and absolute internal links is non-unique and complex relative to directory and filename conventions. :!: Gotcha: The syntax for relative and absolute internal links is non-unique and complex relative to directory and filename conventions.
  
-Paths are absolute if and only if they begin with "/". 
  
 Links are absolute if and only if they have a ":" prefix or have no prefix but do have intermediate (or suffix) ":" Links are absolute if and only if they have a ":" prefix or have no prefix but do have intermediate (or suffix) ":"
Line 28: Line 27:
 Links relative to the current namespace may also begin with either "." or ".:" (".." or "..:" for parent namespace). Links relative to the current namespace may also begin with either "." or ".:" (".." or "..:" for parent namespace).
  
 +===== Referring Images =====
 +
 +Regarding referring of namespaces, images and other media files are handled like wiki pages. That means, the following refers to an image that belongs to the current namespace:
 +<code>
 +{{image.jpg}}
 +</code>
 +
 +
 +
 +===== Deleting namespaces =====
 +
 +When all pages inside a namespace are removed (see [[page#delete_a_page|delete a page]]) the namespace logically doesn’t exist anymore. DokuWiki usually deletes the now empty directory as well.
 +
 +===== How  to rename namespaces? =====
 +
 +==== Manual way ====
 +
 +In order to rename a namespace manually you will have to:
 +  * Rename the folders that represent the namespace in:
 +    * ''data/pages''
 +    * ''data/media'' (if this exists)
 +  * Remove metadata for the namespace under ''data/meta''
 +  * Remove attic data for the namespace under ''data/attic'' (or move that over as well, if you want to preserve old versions)
 +  
 +For example, on a Unix host, you could:
 +  * ''mv /dokuwiki_base/data/pages/old_namespace /dokuwiki_base/data/pages/new_namespace''
 +  * ''mv /dokuwiki_base/data/media/old_namespace /dokuwiki_base/data/media/new_namespace''
 +  * ''rm -Rf /dokuwiki_base/data/meta/old_namespace''
 +  * move: ''mv /dokuwiki_base/data/attic/old_namespace /dokuwiki_base/data/attic/new_namespace'' \\ or remove: ''rm -Rf /dokuwiki_base/data/attic/old_namespace'' 
 +Note that the ''old_namespace'' and/or ''new_namespace'' words may need to be encoded if they are on a non-Latin character set (i.e. Greek, Russian, etc).
 +
 +  * Correct (by editing them) all the links to the pages under the //moved// namespace (you can discover those before moving the namespace by reviewing each page's [[backlinks]]).
 +
 +  * Browse each and every page under the new namespace. This will create the missing indexing information and metadata for the pages under the moved namespace.
 +
 +However, you will still have lots of junk left around. For example in ''data/changes.log'', various files under cache (including the ''.idx'' files etc). If possible you could just start from a ''blank state'' as follows (again under Unix) but be warned that this will mean losing all your historical information (i.e. ''recent changes''):
 +
 +  * ''cat /dev/null > /dokuwiki_base/data/changes.log''
 +  * ''rm -Rf /dokuwiki_base/data/attic/*''
 +  * ''rm -Rf /dokuwiki_base/data/cache/?''
 +  * ''rm -Rf /dokuwiki_base/data/cache/*.idx''
 +  * ''rm -Rf /dokuwiki_base/data/cache/purgefile''
 +  * Browse each and every page of your Wiki.
 +
 +DISCLAIMER: I understand this is convoluted (and maybe I missed/messed a couple of things you should also do). All in all this is a PITA. You may also use a couple of [[plugins]] that are available for (re)building the searchindex for the complete wiki, erasing entire cache and/or old wiki revisions thus avoiding having to do this manually.
 +
 +===== Namespace Default Linking =====
 +
 +It is possible to link to the default page of a namespace by ending the linkid
 +with a colon: ''%%[[foo:bar:]]%%''. Which page the link links to is dependent on the
 +existence of certain named files. For ''%%[[foo:bar:]]%%'' the following pages are
 +checked:
 +
 +<code>
 +foo:bar:$conf['start']
 +foo:bar:bar
 +foo:bar
 +</code>
 +
 +The pages are checked in that order and whatever page is found first will be linked to. [[config:autoplural|Autoplural]] linking is not done for those links.
  
 +See [[config:startpage]] to learn about configuring the startpage name (defaults to ''start'').
namespaces.1506094192.txt.gz · Last modified: 2017-09-22 17:29 by bactram

Except where otherwise noted, content on this wiki is licensed under the following license: CC Attribution-Share Alike 4.0 International
CC Attribution-Share Alike 4.0 International Donate Powered by PHP Valid HTML5 Valid CSS Driven by DokuWiki