Compare Revisions

Learn how to create or improve the canned responses available to support forum contributors. Adding images, wiki markup, and other considerations are covered.

This article explains how to create or improve [[common forum responses|common forum responses]] that are available to contributors for use in support forum replies. Other considerations such as adding images, using wiki markup, or renaming existing forum responses are also covered. __TOC__ = Adding a new forum response = To add a new forum response, simply create a new article. You can use this link: *[/kb/new?title=Forum%20Response]. # Make sure the article is in the "Canned responses" category and that the page title starts with "Forum Response". #Add a link to the new canned response article under the appropriate heading in the [[common forum responses]] article. If no heading is available, add a new one, like this: <nowiki>== Heading under which you want the response to be ==</nowiki> <nowiki>[[Forum Response - Test response|Label you want the response to have]]</nowiki> = Review and approval = Have your submission reviewed by another [/groups/knowledge-base-reviewers KB article reviewer] to minimize errors. Please contact a reviewer or [/user/1036460 Joni] directly if your submission requires immediate attention or hasn't been reviewed in a reasonable amount of time. {warning}'''Warning to reviewers!''' Forum responses that appear in the [[common forum responses]] list will become available to contributors in the support forum, even though the response itself hasn't been approved. When reviewing the [[common forum responses]] list, make sure that newly added forum responses are approved or else make a new edit to delete (or comment out) the unapproved response from the list. {/warning} = Other considerations = == Renaming a response == If you just want to change how the response appears in the support forum "common responses" tool, simply edit the [[common forum responses]] article and change the label you want the response to have. If you also want to change the title of the response article itself, a [/groups/knowledge-base-reviewers KB article reviewer] will need to edit the Description to change the title. {warning}'''Warning to reviewers:''' If you edit the Description of a "Forum Response" article and change the title, its link in the [[common forum responses]] article MUST be updated with the new article title. Otherwise, the canned response won't work when you try to use it on the support forum. {/warning} == Wiki markup == '''Please be careful using wiki markup.''' Keep in mind that certain formatting will show up in the "Forum Response" article but won't work when the response is posted to the support forum. For example: * DO NOT use "show-for" code, as described in [[How to use For]]. * DO NOT use "styling" markup for buttons and menus: <code>{<!-- -->button }</code> and <code>{<!-- -->menu }</code>. * DO NOT use templates: <nowiki>[[T:Open Add-ons|type=Extensions or Appearance or Plugins]]</nowiki> A list of markup that works in both articles and in forum posts is included in the [[Markup chart]] article. Please only use markup that works in forum posts. == Images == If you are including images in a forum response, try to keep them small. The support forum doesn't reduce a large image to fit the page, like a KB article does. Reduce larger images to a width of 520 pixels or less (500 pixels or less for indented images) using this code: <nowiki>[[Image:YourImageName|width=500]]</nowiki>. Also be aware of [https://bugzilla.mozilla.org/show_bug.cgi?id=1019998 bug 1019998] which adds extra line breaks around images posted to the forums.