How to Add Content to the Knowledge Base

Creating or Editing Content

  • A typical word-processor style toolbar gives you access to formatting and the ability to add links, images, videos, tables, columns and code elements.
  • Hovering over any of the buttons pops up a tool tip to show their function.
  • There is also some Knowledge Base-specific functionality.

The First Sentence

The first sentence of a piece of content is used to summarise the content on the summary page of items within a particular category (topic, download type etc.) so it is important to make this first sentence a succinct summary of the content that will let readers know if they wish to view it. Avoid using shortcodes and creating links within this first sentence as they will not show up in summaries or tooltips, which can yield very odd results lacking vital information.

Style Guidance

The style guidance for layout/appearance is available to you at any point when you’re editing. You can see a brief summary of key points, or invoke a pop-up of the full guide to check something without leaving the editor.

Working with Links

From the toolbar, you can create a link to:

  • another piece of content in the Knowledge Base
  • an external web page
  • another place within the page you are editing (an anchor).

To link to an anchor, navigate to the destination you want to use and press the anchor (bookmark) button; give the anchor a single word identifier. Then when you create a link, you will have the option of linking to that anchor. Note: when you create a multi-page article, anchors following page breaks will not be visible and you will need to link to the relevant content using the full URL including the anchor.

If you need to edit a link, click on it within the editor and you will find options to edit the link or remove it.

You must verify that all links you create or edit (anywhere in the KnowledgeBase) work as you expect. Admins will check for broken links on an irregular basis, but it is your responsibility when creating or editing content to include functioning links.

Working with Images, Video and Media

  • Inserting an image (using the Insert/Edit Image button on the toolbar), or simply copying and pasting the image inserts an image from elsewhere on the Internet into the content you’re editing. It will not be available to other pages within the Knowledge Base (unless they also embed it from the original source). However, it might be useful if (for example) you want to display a page from the target website within content such Services & Utilities and Member’s Websites, where it is unlikely to be relevant elsewhere. Note that changes to the original image will not be reflected in the Knowledge Base.
  • One special class of image (ƒh user interface icons) is discussed under Knowledge Base Shortcodes and Other Customisation.
  • To make changes to the way an image is displayed, click on it and you will get a menu of alignment options, a remove option and an edit (pencil) option.
  • If you want to use an image that you think might get re-used, use the Add Media button above the toolbar. You can use an image that has already been placed in the Media Library, or you can upload a new image. If you subsequently make changes to the way it is displayed on a page, you can choose to do that on a single page or everywhere that it’s used (if you decide to do it everywhere, it is your responsibility to check that your changes look OK everywhere it is used.) See Managing Media for more information on how to do this.
  • If you need to add a link to a downloadable file, use the download shortcode.
  • Embed a video from Youtube or Vimeo using the Insert/edit media button on the toolbar.  You cannot upload a video into the Media Library.

Working with Tables and Columns

The Table tool is self-explanatory, but please remember to size table columns in % to make them responsive.

The Columns tool is powerful, once you’ve understood a few basics:

  • It works by inserting shortcodes (an instruction to WordPress in [ ])
  • You can create equal width columns, or Advanced Layouts of mixed widths.
  • There are Utilities available to make sure text following a column element is correctly spaced.

If you intend to use the Columns tool, you should watch this brief demo to get the best out of it.

Inserting Code

You have two options for including code within content.

The simplest way is to use the <> Code button on the toolbar to mark a piece of text as code.

If you want to add a more complex piece of code with syntax highlighting etc. (such as you’ll find in a Code Snippet) then use the {…} Code Insert button. There is no custom syntax highlighting for ƒh data expressions, etc. so <> is the recommended option except for Lua Code Snippets.

Knowledge Base Shortcodes and Other Customisation

There are a few ƒh-specific shortcodes defined for use in the KnowledgeBase, and where such a shortcode exists you must use it (to ensure that the KnowledgeBase still works even when external resources move):

  • Type [fH] or use the fH button on the toolbar to insert ƒh
  • Type [fh_menu] Some > Menu> String[/fh_menu] to highlight an instruction to navigate to the menu position Some > Menu > String, or use the fH Menu button on the toolbar to insert a placeholder shortcode for a menu string.
  • Type [help]page reference|page description[/help] to display a link to a page within the ƒh version 6 help file online; and [help7]page reference|page description[/help7] to display a link to a page within the ƒh version 7 help file online .
    • To get the page reference and page description, you need, navigate to the page in the relevant online Help file. The page description is the title of the page. To get the page reference click Get Link towards the top left (underneath Contents, Index and Search). The page reference you need is the word between ‘#’ and ‘.html’ in the url for the page.
    • Tip: The Help file link Welcome to Family Historian will take you to the V6 help file so you can navigate to the page you need and find the id in the url, and the page title; likewise Welcome to Family Historian will take you to the V7 help file.
  • Type [topic]topic number|topic title[/topic] to link to a FHUG forum discussion, or cut and paste the shortcode from the relevant topic in the forums (click on the * next to the topic title), to display e.g.  Please read BEFORE posting
  • Type [amazon]amazon-description|part-number[/amazon] to link to Amazon for a product to ensure that FHUG gets the affiliate ‘cut’
    • For example, [amazon]Getting-Most-Family-Historian-6|0993542700[/amazon] will yield Amazon
  • Type [plugin]plugin-page-ref|plugin name[/plugin] to link to the plugin store.  Plugin-page-ref is the unique identifier for the plugin, visible at the end the url (following the last /) when you go to the plugin page in the Plugin Store, and plugin name is the name of the plugin.  So [plugin]record-census-data-uk-2|Record Census Data (UK)[/plugin] will yield Record Census Data (UK).
  • Type [download]url|download title[/download] to insert a link to a downloadable file from the media library. The resultant downloaded file will have spaces in the file name instead of hyphens or dashes.  To get the file url, upload the file to the Media Library and click Copy the link (on the right) instead of Insert into…

Often, when you’re describing actions within the ƒh User Interface, it’s clearer to show an icon than it is to simply name it. ‘Click Customise’ is not as clear as ‘Click Customise’. If you click on the ƒh Icons button above the editor, you’ll find the common user interface icons for you to copy and paste as images into content.  Once you have pasted an icon, you need to adjust its alignment and size. Click on it and click the pencil, then in the css class type cs_v and click update. It does not alter on the edit screen but will be the right size and alignment when the page is viewed.

Accordions

You can use the Accordion button to create a piece of content that is hidden until the user chooses to view it, and then remains visible until they choose to close it. It creates a Header (which can be styled as h3, h4 or h5 ) and a placeholder to add the content.