Outline for Knowledge Base Articles

William Mansfield

3/2/2022

In this Article

Article Title and Image
“In this Article” Section
Section Headers
Article structure
Images
Categories
Tags
SEO

Article Title

“Resource Header” block must always be at the top. This includes the title of the article, author, and date.

“In this Article” Section

Following the “Resource Header” there can be a section names “In this Article”. This is not required for all articles, however for longer articles covering a number of points it can be added to aid navigation from the top the specific sections in the page. This should consist of a “Heading” block with the text “In this Article” followed by a paragraph block containing the links to the different sections of the article.

The list of links can be created by simply tying out, then at the end of each link clicking Shift + Enter, rather than just Enter. This will create a more closely spaced list.

Links can then be created by selecting the relevant text, and clicking the “Link” button. To link this to right place in the page you need to enter the HTML anchor for the header of the section you want to jump to with a preceding “#”, for example #article-title-and-image. For how to add HTML anchors jump to here

Section Headers

If your article has a contents and sections for each section you should insert a section header. This should be a “Pattern” under the “Text” category called “Centered Text”.

You will need to remove the Button and Paragraph blocks from this Pattern, leaving just the spacing and the Heading. This should also be left with no background color.

To be able to link to the headings from the “In this Article” section you will need to add HTML anchors to each section heading. This can be done by selecting the section heading, and in the right tool bar select “Block” and then “Advanced”. Here there is the HTML anchor section which should be edited to be same as the section name. This needs to not include any spaces so will automatically insert hyphens “-” between words.

Tip: You can copy and paste the name of the section directly into this box

Article structure

There are a series of elements which can be used to create an article depending on what type on content needs to be displayed in each section. These should be followed for all articles to have a consistent look and feel across all pages

  • Paragraph (Block) – simple continuous text. Always used the “Default” font size, you may need to select the 3 dots and then “Reset All” in the Typography settings to achieve this.
  • Image (Block) – simple image
  • Alternating Feature (Block) – Image on left and Paragraph on right (need to remove Heading and Button). Note: this currently by default loads with the font size “2” however should be “default” this must be set by selecting “Typography” and then the “+” then “Reset all”
  • Centered Heading (Pattern – Text) – to be used for section headers, deleting paragraph and button
  • Centered Heading Background (Pattern – Text) – to be used for tips, deleting the heading and button, using the default “Gray 5” color. These should also start with the text “Tip:” in bold

Images

Images can be uploaded directly as needed. However on doing this they are placed in the root directory for the site. To keep the site organized these need to placed in relevant product sub-folder under “Knowledge Center”. Images can be directly uploaded to this folder from the main WordPress site under “Media”.

Categories

For articles to appear in the Knowledge Base they need to be categorized correctly. This can be done in the side bar, clicking on Resource then Categories.

You must select all the entries in the tree which are relevant. So for an article I want to include in the “Key Concepts” I need to select this element, but also the two higher level hierarchy nodes “PatentSight FAQ” and “Customer Knowledge Center”.

Tags

Tags can be added, these are to aid searching. These are not required and if added should be words which do not already appear in the article. For example adding “semantic search” to the PatentSight Technology Clusters for example. This is not semantic search, but maybe where we want to direct people if they search for this.

SEO (Search Engine Optimization)

Knowledge Base articles will be open to the public, however they will not be indexed and searchable by internet search engines. Therefor SEO features of WordPress can be ignored for Knowledge Base articles

Was this post helpful?