How to Add Content to the Knowledge Base

Managing Media

  • Most of your interaction with the Media Library will be in the context of adding, replacing and changing the display of media items within the context of an article etc.
  • However, you can view the contents of the Media Library using the Media button on your dashboard. In particular, you can get a list of content items where a media file is used, so that you can assess the impact of any changes you’re intending to make to something in the library.
  • If you replace a Media Library item in a piece of content, this may result in an old item that is no longer used.  Admins will review the library on an irregular basis and tidy it up as necessary.
  • You can add new media in advance of it being required; this might be useful if you want to bulk upload a set of screenshots, for example.

Code Snippets

Code Snippets are very simple pieces of content. They have:

  • a title
  • a body
  • an ƒh version

The body should:

  • Describe what the snippet does/how it works
  • Include one of more code blocks containing the snippet and related code (e.g. usage examples) constructed using {…} on the editor toolbar
    • Make sure you select Lua highlighting

When viewed, the code blocks will be highlighted to show the Lua syntax, and have an icon when you hover over a code block to copy it to the clipboard for pasting into a plugin.

Creating Glossary Entries

Glossary items are very simple but important pieces of content.

  • The Glossary Term Title is the word or phrase that, when used in another piece of content, will trigger the display of the Glossary pop-up the first time it is encountered. Matching is not case sensitive.
  • The pop-up is limited to the first 40 words of the glossary entry; take care to make this a meaningful definition of the term.  The entire entry should be less than 40 words.
  • You can also define Additional key terms for an entry — terms which don’t match the Glossary Term Title but which should still lead to the same term definition (to cater for differences in terminology for the same thing by different authors, or to associate e.g. both Events and Attributes with the Fact Glossary entry).
  • If users click on the Glossary pop-up, there are a number of options:
    • The default option is to display the whole of the Glossary item — this allows for a simple definition just a little longer than 40 words.  Do not use this option.
    • Alternatively, a Glossary term can define an internal or external link that will be opened. An internal link might be a long article on using some aspect of ƒh. An external link might be to guidance on some aspect of genealogy best practice.
    • We recommend you set internal links to open in the same window, and external links to open in a new window (the default); and also to mark the links as “No Follow”.

Deleting Content

If you believe a piece of content is no longer required, change its status to Draft (in the Publish pane of the editor) and rename it to start with DELETE ME. Then use the Contact form to advise admins to review and delete it. Explain in your message why you want to delete it, so your request can be handled rapidly.