Knowledgebase - Revision history

SarahK: /* Articles */

2022-07-07T15:53:30Z

‎Articles

SarahK: /* Articles */

2022-07-07T15:52:00Z

‎Articles

SarahK at 15:50, 7 July 2022

2022-07-07T15:50:41Z

SarahK at 22:05, 14 April 2022

2022-04-14T22:05:30Z

SarahK at 21:49, 1 March 2022

2022-03-01T21:49:59Z

SarahK at 18:38, 17 December 2021

2021-12-17T18:38:34Z

Matt: /* Image Uploading */

2020-03-12T17:20:26Z

‎Image Uploading

Nathan: /* Storage */

2020-03-12T14:36:27Z

‎Storage

Nathan: /* Storage */

2020-03-12T14:35:57Z

‎Storage

Nathan: /* Storage */

2020-03-12T14:35:27Z

‎Storage

@@ Line 26: / Line 26: @@
 # Enter an article name.
 # Click '''Add Article'''.
-# Select the article's category or categories.
+# Select the article's category or categories. To select more than one category, <tt>CTRL</tt>+click on the desired categories.
 # If you want to manually set the views or votes for the article, enter the desired numbers in '''Views''', '''Votes For''', or '''Total'''.
 # If you want to override the default alphanumeric display order, enter the desired number or letter in '''Display Order'''. For example, entering <tt>0</tt> would cause the article to display at the top of the category.
 # Check '''Private''' to only allow logged-in users to view the article.
-# Enter the desired tags by typing them into '''Tags'''. For more information about tags, [[#Tags|see the Tags section below]].
+# Enter the desired tags by typing them into '''Tags'''. For more information, see [[#Tags|Tags]] below.
 #* Matching existing tags will display as you type. Press '''Enter''' to add the displayed tag.
 #* To add a new tag, enter it and then press '''Enter''' or '''Space'''.
 #* Tags cannot contain spaces.
-# Enter the article content and apply your desired formatting.
+# Enter the article content and apply your desired formatting. For more information, see [[#Images|Images]] below.
 # To translate the article into additional languages, click that language under '''Multi-Lingual Translations''' under the text box. Then, translate the article in the new text box that appears.
 # Click '''Save Changes'''.

@@ Line 32: / Line 32: @@
 # If you want to override the default alphanumeric display order, enter the desired number or letter in '''Display Order'''. For example, entering <tt>0</tt> would cause the article to display at the top of the category.
 # Check '''Private''' to only allow logged-in users to view the article.
-# Enter the desired tags by typing them into '''Tags'''. For more information about tags, [[#Tags see the Tags section below]].
+# Enter the desired tags by typing them into '''Tags'''. For more information about tags, [[#Tags|see the Tags section below]].
 #* Matching existing tags will display as you type. Press '''Enter''' to add the displayed tag.
 #* To add a new tag, enter it and then press '''Enter''' or '''Space'''.
 #* Tags cannot contain spaces.
 # Enter the article content and apply your desired formatting.
-#* To upload images, see [[#Images Images]] below.
+#* To upload images, see [[#Images|Images]] below.
 # To translate the article into additional languages, click that language under '''Multi-Lingual Translations''' under the text box. Then, translate the article in the new text box that appears.
 # Click '''Save Changes'''.

@@ Line 1: / Line 1: @@
-The knowledgebase feature allows you to create a collection of commonly asked questions and their answers. Articles can be grouped into categories, and categories can be either public or hidden, allowing you to create staff only knowledgebase entries too.
+You can use the WHMCS knowledgebase to create a collection of important information, including frequently-asked questions and their answers. You can group articles into public or hidden categories, allowing you to create separate knowledgebases for customers and staff.
 You can access this feature at '''Support > Knowledgebase'''.
-The client area offers the user the choice of browsing through the articles in your KB by category, popular tags or searching based on keywords they enter.
+The Client Area offers the user the choice of browsing through the articles by category, by popular tags, or by searching for keywords.
-===Creating Categories & Articles===
+== Categories ==
-* Click the Add Category tab
+Before you can start creating articles, you must create at least one category to store them in.
-===Editing Articles===
+To do this:
-To edit an existing article simply click the category name and then the article name.
+# Go to the '''Add Category''' tab.
-===Tags===
+== Articles ==
-Knowledge base tags are available to highlight keywords relating to an article.
+Articles are the pages that comprise the knowledgebase. Each article exists in at least one category.
-Tags allow you to group articles across multiple categories that share a common theme. Tags are then used to generate a Tag Cloud showing the most common themes in articles and allowing all articles associated with a given tag to be viewed.
+To create an article:
-Tags that occur more frequently will display in a larger font providing an indication of the number of articles for a given tag.
+# Go to the '''Add Article''' tab.
-====Managing Tags====
+To edit an existing article, click the appropriate category names until you see the desired article, and then click the article name. Make the desired updates and then click '''Save Changes'''.
-* Navigate to the article you wish to modify tags for
+=== Tags ===
-===Image Uploading===
+Knowledgebase tags highlight keywords for an article. You can use them to group articles across multiple categories that share a common theme.
-<div class="docs-alert-info"><i class="fa fa-info-circle"></i> This section describes features available in version 7.10 and above</div>
+Tags can generate a Tag Cloud showing the most common themes in articles and allowing the user to view all articles associated with a given tag regardless of category. Tags that occur more frequently will display in a larger font.
-Images can be uploaded through the knowledgebase rich text editor from the Insert → Image menu.
+=== Images ===
-[[File:KBUploadMenu.png]]
+<div class="docs-alert-info">
-On the Insert/Edit image modal that appears, choose the Upload tab and follow the prompts. Once uploaded, the image URL will be inserted automatically a the point of the cursor.
+To upload images using the Knowledgebase rich text editor:
-After an image has been uploaded, it will be available for re-selection in the insert image popup under the '''Recent images''' select box. The Recent images select box will contain the last 25 uploaded images. This provides a faster and more convenient way to re-use the same images in translations or multiple articles.
+# In the rich text editor, select '''Insert > Image'''. <br/>[[File:KBUploadMenu.png]]
 [[File:KBUploadPopup.png]]
-==== Storage ====
+Your settings at '''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > System Settings > [[Storage Settings]]''' determine where to store uploaded images.

@@ Line 1: / Line 1: @@
 The knowledgebase feature allows you to create a collection of commonly asked questions and their answers. Articles can be grouped into categories, and categories can be either public or hidden, allowing you to create staff only knowledgebase entries too.
-You can work with your knowledgebase at '''Support > Knowledgebase'''.
+You can access this feature at '''Support > Knowledgebase'''.
 The client area offers the user the choice of browsing through the articles in your KB by category, popular tags or searching based on keywords they enter.

@@ Line 1: / Line 1: @@
-The knowledgebase feature allows you to create a collection of commonly asked questions and their answers.
+The knowledgebase feature allows you to create a collection of commonly asked questions and their answers. Articles can be grouped into categories, and categories can be either public or hidden, allowing you to create staff only knowledgebase entries too.
-Articles can be grouped into categories, and categories can be either public or hidden, allowing you to create staff only knowledgebase entries too.
+You can work with your knowledgebase at '''Support > Knowledgebase'''.
 The client area offers the user the choice of browsing through the articles in your KB by category, popular tags or searching based on keywords they enter.
@@ Line 7: / Line 7: @@
 ===Creating Categories & Articles===
-* The first step is to create a category to contain articles, navigate to '''Support > Knowledgebase''' and click the Add Category tab
+* Click the Add Category tab
 * Enter a name and description to be displayed to clients. Check the Hide checkbox to make this category invisible, it will only be visible in the admin area. Click Add Category.
 * Now click the Add Article tab and enter the title of the first article and click Add Article to be taken to the editing page.

@@ Line 8: / Line 8: @@
 * The first step is to create a category to contain articles, navigate to '''Support > Knowledgebase''' and click the Add Category tab
-* Enter a name and description to be displayed to clients. Tick the Hide checkbox to make this category invisible, it will only be visible in the admin area. Click Add Category.
+* Enter a name and description to be displayed to clients. Check the Hide checkbox to make this category invisible, it will only be visible in the admin area. Click Add Category.
 * Now click the Add Article tab and enter the title of the first article and click Add Article to be taken to the editing page.
 * The Category field displays which categories this article belongs to, a single article can be assigned to multiple categories by ctrl + clicking.
 * The views and votes statistics can be changed here, it displays how many people have viewed this article and how many rated it helpful.
-* Ticking the Private checkbox will mean this article is not visible to visitors so clients must be logged in to read it.
+* Checking the Private checkbox will mean this article is not visible to visitors so clients must be logged in to read it.
 * The Display Order enables the default alphanumeric display order (1,2,3,a,b,c...) to be overridden with a custom one. An article with a display order value or 0 would be displayed at the top of the category, 1 beneath that, 2 beneath that and so on.
 * Enter the contents of your article in the large text area.

← Older revision		Revision as of 14:36, 12 March 2020
Line 50:		Line 50:
	==== Storage ====		==== Storage ====

−	Knowledgebase images use a Storage Setting to define where uploaded images are stored. On upgrade to WHMCS 7.10, or a new install of WHMCS, a default Storage Setting is used which can be checked and changed if required.	+	Knowledgebase images use a [[Storage Settings\|Storage Setting]] to define where uploaded images are stored. On upgrade to WHMCS 7.10, or a new install of WHMCS, a default Storage Setting is used which can be checked and changed if required.

← Older revision		Revision as of 14:35, 12 March 2020
Line 50:		Line 50:
	==== Storage ====		==== Storage ====

−	Knowledgebase images use a [[Storage Setting]] to define where uploaded images are stored. On upgrade to WHMCS 7.10, or a new install of WHMCS, a default Storage Setting is used which can be checked and changed if required.	+	Knowledgebase images use a Storage Setting to define where uploaded images are stored. On upgrade to WHMCS 7.10, or a new install of WHMCS, a default Storage Setting is used which can be checked and changed if required.