Contribute Your Knowledge ~ Create And Manage Pages

FIXME Need to correct all links and review them if their targets get moved.

Introduction

This page provides instructions for creating and managing Pages within the existing Knowledge Base structure.

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

Namespaces are used to categorize Pages, and can be thought of as folders or directories, in that they allow Pages with related subjects to be grouped together.

Pages are the core Knowledge Base content.

All Pages (and potentially sections within Pages) in the Knowledge Base are accessed via Hyperlinks. These Hyperlinks may be found as part of the content on other Knowledge Base Pages, but there are also a number of key pages whose sole purpose is to help readers navigate to the information they need, and which you should therefore ensure reflect any new content that you produce:

  • The Knowledge Base Home which provides top-level guidance about what is available within the Knowledge Base and should not be edited without consulting the administrators in the Web Site Usage forum.
  • An Index page for each Namespace that summarises the content of that Namespace, provides links to the top-level pages that it holds, and also to:
    • An index of the latest changes in the Namespace
    • FAQS for the Namespace
    • An Alphabetic index of the Namespace by Page Title
    • An reference book style Alphabetic index of the Namespace.

If you follow the instructions below for managing content, the relevant indices will eventually be updated automatically. To quicken that process, post a request to an administrator in the Web Site Usage forum.

What Sort of Page

Each Knowledge Base section is allocated to one of the available Namespaces, which are detailed at Knowledge Base Namespaces.

It is almost certain that any page you want to create will fit within the available Namespaces, so you should choose the Index Page for the relevant Namespace as the starting point for creating your page, following the instructions below.

If you really believe your page doesn't fit within the existing categories you should consult the administrators in the Web Site Usage forum BEFORE creating a new namespace.

Create Pages

New pages are created in two stages: first, insert a hyperlink and then create the contents of the page. If multiple pages are needed to cover a subject adequately, an index subsection should be created first, within which the new pages should be linked.

Choose the appropriate contents index page that needs the new page, and edit a Hyperlink for the new page name into this page. The new page name should reflect the intended topic, but this can be adjusted later.
e.g.

  * [[One New Page]]

Contents pages usually present page links in an unordered bullet list, so don't forget the asterisk (*).

Save the contents index page, and note that the link is red, because the page has not yet been created.

Single Page: Create the Page

Click on the red link and the new page will open with the headline This topic does not exist yet.

Click on the Tools > Create this page option in the Tools menu at the top-right of the page.

Edit the page contents, giving some consideration to the ====== Level 1 Headline ======, because this headline will appear in the contents index page in place of the page name link. This headline will also appear as the link name for any other link to this new page. However, in both these cases the name can be overridden with Link Text. The headline will also get listed in the root namespace Alphabetic Titles, and the overall Knowledge Base Titles, but cannot be altered with Link Text.

If you want to leave the page in an 'unfinished' state, then use the FIXME code FIXME icon as a reminder.

Use the Preview button to check what the page will look like.

If you decide not to create the page after all, then click the Cancel button and OK button, and if necessary delete the original hyper-link.

When your initial editing is finished, remember to Save the page.

For more information about creating your page, see Edit Existing Pages.

Multiples Page: Add a New Subsection

If your subject needs more than a single page to cover it adequately, you should add another contents index subsection to the appropriate contents index page, and then create the index page for the subsection. This requires a similar two stage process. Once this is done, you can add pages to your subsection as described above.

Insert a Hyper-Link for the new index page name into the parent contents page.
e.g.

  * [[.:New Subsection:Index]]

This will create a namespace for the new subsection. Later you will add individual subsection pages to the new subsection contents index page.

Create the Subsection Index Page

Click on the red link and the new page will open with the headline This topic does not exist yet.

Click on the Tools > Create this page option in the Tools menu at the top-right of the page.

Choose an appropriate ====== Level 1 Headline ====== for this subsection contents page, and perhaps insert an introduction to the subsection topic, then Save the page.

Now you can use the instructions above to add pages to your subsection.

Tip: Add a Draft Page

There may be occasions (e.g. if you expect a page to take a long time to be constructed) when you wish to restrict its visibility.

In this case:

  • Create a page as documented above
  • Bookmark the newly created page so that you can return to it as necessary
  • Mark the page with the Fix Me icon in case anybody stumbles across it
  • Delete the parent page hyperlink
  • When you're ready to publish, re-instate the parent page hyperlink

The page will not be totally hidden – it will still appear in the root namespace Alphabetic Titles, and the overall Knowledge Base Titles, or when some indices are automatically updated, but it will be less visible to chance visitors.

Delete a Page

If you create a page by mistake, or a page becomes redundant, you can delete it.

First check how many other pages link to this old page, by using the Tools > Backlinks command to reveal any backlinks to this page.

If there are a great number of backlinks, the page is clearly not redundant and should not be deleted.

Otherwise, edit the listed pages that contain these links until the command says there are no backlinks.

Now Edit this old page, then click the Page Management page management link at the bottom of the page, and use its Page Deletion form to give a Reason before ticking the boxes and clicking Save.

An alternative method is to insert the DELETEME code DELETEME icon and request an administrator to remove the page via the Web Site Usage forum.

Move or Rename a Page

Edit the page, then click the Page Management page management link at the bottom of the page, and use its Page Rename form to give the New name and Reason before ticking the boxes and clicking Save.

If the New name is just a Page name then it will be renamed.

If the New name includes a Namespace then the Page will be moved.

Any Backlinks to this Page will be automatically updated.

Alternative Index Entries

Sometimes one page will cover several things that need to be indexed under more than one heading.
e.g. [[glossary:dates:Using the Julian and Gregorian Calendars]]

i.e. Using the Julian and Gregorian Calendars needs index entries for Julian Dates and Gregorian Dates as well.

To do this we use the glossary:alt namespace and the Alternate Wiki Pages page.

Simply add a new page hyper-link to this page for each alternative entry you want.
e.g.

[[glossary:alt:Julian Dates]]
[[glossary:alt:Gregorian Dates]]

Then click on each link and create the page as described earlier. The template in the glossary:alt namespace will do most of the work for you. Simply replace the bit that says "replace with page link", with the page name you want to go to, but without the double square brackets.
e.g.

See ~~GOTO>replace with page link~~

becomes

See ~~GOTO>glossary:dates:Using the Julian and Gregorian Calendars~~

Shared Page Contents

Sometimes the same text needs to be included in many Pages. To avoid replicating the text and to simplify amending it, one Page of text can be shared with many Pages; just like fh shared Note records can be included in many other records.

The Include Plugin defines a {{page>page&flags}} macro that allows any Page to be included in any other Page.

The pages to be shared should be created in the Insert Pages namespace. Examples are the Installation Instructions shared by Downloads and Links pages, such as Query:Fact ~ All Facts on Day Month. e.g.

{{page>insertpages:di_Query_Fact&nofooter&noheader}}

produces the Installation Instructions for a Fact Query as reproduced below:

Click on the link below to download and save FHQ file, then double click it to import to Family Historian Version 4 or later.

It will Import into earlier versions, but does not work, and can only be deleted using View > Custom Queries > Delete Custom Query.

Update Crossreferences

These crossreferences involve the Categories for the Downloads and Links and Member Web Sites, plus the reference book style Knowledge Base Index. When any crossreferences are changed they will eventually be updated automatically, but to quicken that process, post a request to an administrator in the Web Site Usage forum.

Categories

This technique offers users easy ways to contribute to the Downloads and Links and Member Web Sites that will automatically list their new Page in the chosen Categories without manually adding a Hyperlink to each Category Page.

The Tag Plugin defines the {{tag>tag1 tag2 tag3}} and {{topic>tag #flags}} macros. Every page that specifies an appropriate Tag value will appear in a Page that specifies a matching Topic for the Category.

For example, in the Downloads and Links, if a Page has the {{tag> Icons Census }} macro, then it will be listed in the Diagram Icons Category via the {{topic>.? Icons &list&nodate&nouser}} macro and similarly in the Census Records Category via the {{topic>.? Census &list&nodate&nouser}} macro.

Alphabetic Index

This technique allows any Page or Section to be listed in a reference book style subject index under one or more topics that are more helpful than their headline titles.

The Subject Index Plugin defines the {{subjectindex>options}} and {{entry>sect;topic;text*}} macros. The {{entry>}} macros are manually edited into any Page to define the subject topics, and the {{subjectindex>}} macro then lists them alphabetically in the Knowledge Base Index pages with hyperlinks in both directions.

For example, the Family Historian Plugins page contains the following macros:

{{entry>Plugins/Basic Guide;See Index for related topics.}}
{{entry>Family Historian/Plugins;-*}}

They define a Plugins topic and Basic Guide sub-topic, plus a Family Historian topic and Plugins sub-topic.

The Family Historian Plugins page displays See Index for related topics. and an asterisk, that are hyperlinks to the Knowledge Base Index page.

The Knowledge Base Index page contains the macro:

{{subjectindex>default}}

which lists those topics under the index section letters P for Plugins and F for Family Historian respectively, with hyperlinks to the Family Historian Plugins page.