Contribute Your Knowledge ~ Namespace Concepts

Introduction

This guide explains the naming conventions and structures used to organise Namespaces and Pages in the Wiki, and how that is applied to the Knowledge Base implementation.

The earliest sections explain the basic features, and the later sections need a little more expertise.

Return to Overview Page.

Namespace Conventions

This Knowledge Base or Wiki is structured as a set of Namespaces that hold collections of Pages.

The Namespaces are used to categorize Pages, and are similar to folders or directories, as they allow Pages with related subjects to be grouped together.

Syntax Rules

Namespace and Page paths comprise dots (.), colons (:), lowercase letters (a-z), digits (0-9), and underscores (_). While the rules define how to interpret those paths.

The current Namespace and Page path appears after https://www.fhug.org.uk/wiki/wiki/doku.php?id= in the browser address bar. Navigation to a Page is performed by clicking a Hyperlink which identifies the target Namespace and Page path using the following formats within double square brackets.

[[namespace:pagename]]
Advised Absolute Path Formats
wiki:ns1:page1 Page page1 is in the ns1 namespace within wiki in the root namespace
wiki:ns1:ns:page2 Page page2 is in ns within ns1 within wiki in the root namespace
wiki:ns2:page3 Page page3 is in the ns2 namespace within wiki in the root namespace
Advised Relative Path Formats Equivalent to those three above with a current namespace of wiki:ns1
.page1 or page1 Page page1 is in the current namespace i.e. wiki:ns1:page1
.:ns:page2 Page page2 is in ns within current namespace i.e. wiki:ns1:ns:page2
..:ns2:page3 Page page3 is in ns2 within parent namespace i.e. wiki:ns2:page3

It is advised that Absolute Paths have no prefix, and Relative Paths use one of the . prefix forms shown above.
See namespaces for full details of all the alternative formats.

As explained later, Absolute Paths are easier to create with the tools, whereas Relative Paths must be created manually but allow a cluster of Pages in a Namespace to be moved to another Namespace without needing to correct any links.

To link to any Headlines within a page (known as bookmarking), add the Headline name after a hash character.
This links to this subsection.

This links to [[ContributeYourKnowledge:Namespace Concepts#Namespace Conventions|this subsection]]. 

Name Mappings

When defining path names most characters are allowed (excluding dots and colons), but they are mapped to actual paths by converting to lowercase and replacing any sequence of non-alphanumerics with one underscore.
Thus Wiki:New Page and Plugin:Help & Advice map to wiki:new_page and plugin:help_advice

Usually a new Page top level Headline is automatically created from a reverse mapping where each word is capitalised and each underscore becomes a space. i.e. ===== New Page ===== and ===== Help Advice =====
but that Headline can be edited to whatever is preferred.

The structure of a new page is governed by a Template for the Namespace and managed by the administrators.

Return to Overview Page.

Knowledge Base Structure

Each Knowledge Base section is allocated one of the root Section Namespaces, and each root Namespace comprises a similar set of standard Namespace Pages.

Section Namespaces

Each active root Namespace in this Knowledge Base is listed here.

Namespace Section Headline Description
how_to Family Historian Details of Family Historian 1)
plugins FH V5 Plugins Details of Family Historian Plugins
ancestralsources Ancestral Sources Details of Ancestral Sources
research Genealogy Research Details of Genealogy Research
contributeyourknowledge Contribute Your Knowledge Details of Contribute Your Knowledge
fhugdownloads Downloads and Links Details of Downloads and Links
links Member Web Sites Details of Member Web Sites
glossary Glossary of Terms Reference Glossary of Features
faq FAQs Index Reference Frequently Asked Questions
knowledge_base_titles Knowledge Base Titles Reference Knowledge Base Titles
alphabetic_index Knowledge Base Index Reference Knowledge Base Index

The Namespaces are used in Links such as [[ancestralsources:alphabetic_index]]Ancestral Sources Alphabetic Index.

These names are case insensitive and space characters become underline characters, so [[AncestralSources:Alphabetic Index]] links to the same page as [[ancestralsources:alphabetic_index]].

The How To Guides and Other Resources hold the majority of the pages that provide the Knowledge Base help.

The Frequently Asked Questions is a composite of all the How To Guides and Other Resources FAQ subsections and will rarely need changing.

The Glossary of Features maintains a logically grouped index of pages about common topics, with "stub" pages or Alternative Index Entries to link back to other section pages where necessary. Examples are Ancestral Sources and Julian Dates. The Glossary of Features opens with a Popular Topics group, which contains entirely "stub" page links.

The Knowledge Base Titles page provides a complete alphabetic index of page headline titles for the whole Wiki, and has the following code.

====== Knowledge Base Titles ======
~~NOCACHE~~
This lists all the section titles of the Knowledge Base Wiki in alphabetical order.

To find a particular topic try the **Search** box top right, or the [[:Alphabetic Index]].

{{alphaindex>|nons [#10] [nons] [remove "|nons" to reveal namespaces] }}

The Knowledge Base Index page provides a reference book style alphabetic index for the whole Wiki, and has the following code.

====== Knowledge Base Index ======
~~NOCACHE~~
This index lists popular topics from the [[:Home|Knowledge Base]] in alphabetical order.

. . . . . . . . . .

====== Subject Index ======

~~NOSUBJECTINDEX~~

These shortcuts link to the **Index** section with a matching letter: 
[[#si-A|A]] [[#si-B|B]] [[#si-C|C]] [[#si-D|D]] [[#si-E|E]] [[#si-F|F]] [[#si-G|G]] [[#si-H|H]] [[#si-I|I]] [[#si-J|J]] [[#si-K|K]] [[#si-L|L]] [[#si-M|M]] [[#si-N|N]] [[#si-O|O]] [[#si-P|P]] [[#si-Q|Q]] [[#si-R|R]] [[#si-S|S]] [[#si-T|T]] [[#si-U|U]] [[#si-V|V]] [[#si-W|W]] [[#si-X|X]] [[#si-Y|Y]] [[#si-Z|Z]]

Hover on any **Index** link and a popup tooltip provides more details. Each **Index** link will open the wiki page near the topic, which is marked by {{entry>Topic;See Index for related topics}} or an asterisk {{entry>Topic;-*}} that when clicked will return to the original **Index** link on this page.

{{subjectindex>default}}

Namespace Pages

Most sections have at least the following types of Page.

Pagename Example Description
index Ancestral Sources Contents page for the section
about About Ancestral Sources Summary page about the section
changes Ancestral Sources Latest Changes Latest changed pages in section
faq Ancestral Sources FAQs FAQ page for the section
titles Ancestral Sources Alphabetic Titles Titles index page for section
alphabetic_index Ancestral Sources Alphabetic Index Book style index page for section
getting_started Getting Started with Ancestral Sources Getting started page for section

Index Page

Each index page provides a table of contents for its section, for example see [[ancestralsources:index]]Ancestral Sources.

Every index page typically begins with the following style of code and reference links.

====== Section Title Contents ======

===== Introduction =====

  * [[About]]

  * **Changes, FAQs, Titles & Index**
    * [[Changes]]
    * [[FAQ]]
    * [[Titles]]
    * [[Alphabetic Index]]

About Page

Each about page provides an introduction to its section, for example see [[ancestralsources:about]]About Ancestral Sources.

Latest Changes Page

Each changes page lists the 10 most recently created or significantly edited pages in the section, for example see [[ancestralsources:changes]]Ancestral Sources Latest Changes.

Every changes page contains the following style of code.

====== Section Title Latest Changes ======

===== Latest Created & Edited Pages =====

If nothing is listed below, then there have been no recently created or significantly edited pages.

{{changes>namespace&render=pagelist(header,date,nouser,desc)&type=create,edit}}

Click [[http://www.fhug.org.uk/wiki/doku.php?id=namespace:changes&do=recent|Recent changes]] 
to see a complete list for both **Pages** and **Media**, 
including **Removals** and **Minor changes**, 
and optionally for the whole **Knowledge Base** Wiki.

FAQ Page

Each faq page lists frequently asked questions for its section, for example see [[ancestralsources:faq]]Ancestral Sources FAQs.

Every faq page contains the following style of code.

====== Section Title FAQs ======

===== Frequently Asked Questions =====

  * [[Question One?]]
  * [[Question Two?]]

Alphabetic Titles Page

Each titles page provides an alphabetically sorted index of page titles for its section, for example see [[ancestralsources:titles]]Ancestral Sources Alphabetic Titles.

Every titles page contains the following style of code.

====== Section Title Alphabetic Index ======

~~NOTOC~~
~~NOCACHE~~

This index lists **Section Title** page titles from the [[:Home|Knowledge Base]] in alphabetical order.

For full cross references please see the [[:Knowledge Base Titles]] and [[:Alphabetic Index]] or try the **Search** box top right.

{{alphaindex>namespace|nons}}

Alphabetic Index Page

Each alphabetic_index page provides a reference book style alphabetical index for its section, for example see [[ancestralsources:alphabetic_index]]Ancestral Sources Alphabetic Index.

Every alphabetic_index page contains the following style of code.

====== Section Title Alphabetic Index ======

~~NOTOC~~
~~NOCACHE~~
~~NOSUBJECTINDEX~~

This index lists **Section Title** topics from the [[:Home|Knowledge Base]] in alphabetical order.

For full cross references please see the [[:Knowledge Base Titles]] and [[:Alphabetic Index]] or try the **Search** box top right.

===== Index =====

These shortcuts link to the **Index** section with a matching letter: 
[[#si-A|A]] [[#si-B|B]] [[#si-C|C]] [[#si-D|D]] [[#si-E|E]] [[#si-F|F]] [[#si-G|G]] [[#si-H|H]] [[#si-I|I]] [[#si-J|J]] [[#si-K|K]] [[#si-L|L]] [[#si-M|M]] [[#si-N|N]] [[#si-O|O]] [[#si-P|P]] [[#si-Q|Q]] [[#si-R|R]] [[#si-S|S]] [[#si-T|T]] [[#si-U|U]] [[#si-V|V]] [[#si-W|W]] [[#si-X|X]] [[#si-Y|Y]] [[#si-Z|Z]]

Hover on any **Index** link and a popup tooltip provides more details. Each **Index** link will open the wiki page near the topic, which is marked by {{entry>Topic;See Index for related topics}} or an asterisk {{entry>Topic;-*}} that when clicked will jump to the related **Index** link on the global [[:Alphabetic Index]] page.

{{subjectindex>cols=1;title;regex=Section Title}}

Getting Started Page

Only How To Guides have a getting_started page, for example see [[ancestralsources:getting_started]]Getting Started with Ancestral Sources.

These pages are further supplemented with all the other help pages for the section, and often further subsection pages as well.

Root Pages & Namespaces

There are some pages that do not fit into the above structure, but rarely need altering, or maybe need relocating.

To discover all pages that may exist in namespaces use the Full Site Map by namespace function.

The special homeKnowledge Base Home page holds the welcome page displayed when the Wiki is first opened.

The special sidebarSidebar page contains the hyper-links presented in the main sidebar.

The extras root namespace holds various Plugin details pages:

extras:pushfile Pushfile Plugin required by the Pushfile Plugin Macro
extras:fh FH Dokuwiki Plugin holds some FH Dokuwiki Plugin details

The info root namespace has many pages of information & images, and maybe needs collating together somewhere:

info:about_fhug About the FHUG Web Site Usage listed on Knowledge Base Home page
info:alphabetic_index FHUG Web Site Usage Alphabetic Index listed on Knowledge Base Home page
info:changes FHUG Web Site Usage Latest Changes listed on Knowledge Base Home page
info:contact Contact Us listed on Knowledge Base Home page
info:cookies Cookies Usage listed on Knowledge Base Home page
info:faq FHUG Web Site Usage FAQs listed on Knowledge Base Home page
info:forums Forums Usage Tips listed on Knowledge Base Home page
info:forums_posting_guidelines Forums Posting Guidelines listed on Forums Usage Tips above
info:mailing_list FH Mailing List listed on Knowledge Base Home and Sidebar
info:privacy Privacy Policy listed on Knowledge Base Home page
info:signing_up Signing Up For Editing listed via lots of Backlinks
info:support_fhug Support FHUG listed on Knowledge Base Home page
info:titles FHUG Web Site Usage Alphabetic Titles listed on Knowledge Base Home page
info:what_is_a_wiki What is a Wiki? listed on Knowledge Base Home and FHUG Web Site Usage FAQs and About Contribute Your Knowledge
info:wish_list Wish List listed on Sidebar and About the FHUG Web Site Usage

The insertpagesInsert Pages namespace holds pages predominantly shared by Downloads and Links pages for installation instructions or other multiple use details.

The wiki root namespace has pages of details about DokuWiki:

wiki:dokuwiki DokuWiki listed via lots of Backlinks
wiki:syntax Formatting Syntax listed via lots of Backlinks
wiki:syntaxorg Formatting Syntax without Backlinks and redundant?
wiki:welcome Welcome to your new DokuWiki listed in Reference Material

The playground:playgroundPlayGround page and associated pages are used for experimentations.

Return to Overview Page.
1)
Namespace how_to should be familyhistorian