Support/Editor:PRD: Difference between revisions

From MozillaWiki
Jump to navigation Jump to search
(New page: Firefox Support Knowledge Base Editor Requirements Document =Overview= Intuitive and simplified Knowledge Base article editor. ==Permissions== * When creating a new article, all options ...)
 
No edit summary
Line 3: Line 3:
=Overview=
=Overview=
Intuitive and simplified Knowledge Base article editor.
Intuitive and simplified Knowledge Base article editor.


==Permissions==
==Permissions==
* When creating a new article, all options are available.
* When creating a new article, all options are available.
* After an article has been created, only an admin can change the language.
* After an article has been created, only an admin can change the language.
* When editing an article only locale leaders and admins can change an article category. (Staging area, Knowledge Bae, Live Chat, etc.)
* When editing an article only locale leaders and admins can change an article category. (Staging area, Knowledge Base, Live Chat, etc.)
 
* When editing a staging copy, category cannot be changed.


==Fields that require entered data==
==Fields that require entered data==
* Lanugage
* Language
* Summarize your edit and cite a reference
* Summarize your edit and cite a reference
=Options=
* Language: drop-down menu to select language (unknown language not allowed)
* Category:
** Administration (only available to admins and locale leaders)
** How to contribute (only available to admins, locale leaders, and approvers)
** Live Chat
** Knowledge Base (only available to admins, locale leaders, and approvers)
** Staging Area
** Sandbox/Testing Area
* This article applies to:
** Firefox 2 - The content of this article applies to users of Firefox 2.x.
** Firefox 3.0 - The content of this article applies to users of Firefox 3.0.x.
** Firefox 3.1 - The content of this article applies to users of Firefox 3.1
* Type of article:
** Help article  - This article is a reference chart, tutorial, or a how-to article.
** Troubleshooting article - This article is for solving a problem.
* Summarize your edit and cite a reference:
** Mark other translations as out of date (only available on English articles)
==Toolbar items==
* Bold
* Italics
* Wiki link
* External link
* Numbered list
* List
* H1
* H2
* H3
* Menu path
* Button
* Kbd
* File name/path
* Pref name/value
* Code
* Note
* Warning
* Insert Image (will pop up prompt for:)
** Image uploader (mandatory)
** Image height
** Image width
** Alignment
* SHOWFOR (will trigger a drop-down, that includes:)
** Windows
** Mac
** Linux
** Windows and Mac
** Windows and Linux
** Mac and Linux
** –separator–
** Firefox 3.1
** Firefox 3.0
** Firefox 3.0 and 3.1
** Firefox 2
* Dynamic Content (will trigger a drop-down that includes all content labels for the language assigned to the article)
==Viewing options==
Tabs at the bottom of content area will choose what you view.
* Windows
* Mac
* Linux
* Source (if you want to edit the tikiwiki markup)
=Mockups=
* [http://ilias.ca/sumo/creating_an_article.xhtml Creating a new article]
* [http://ilias.ca/sumo/staging_copy_non-locale_leader.xhtml Editing a staging copy]
=Technical Requirements=
* WYSIWYG editor {bug|454131}

Revision as of 03:06, 24 November 2008

Firefox Support Knowledge Base Editor Requirements Document

Overview

Intuitive and simplified Knowledge Base article editor.


Permissions

  • When creating a new article, all options are available.
  • After an article has been created, only an admin can change the language.
  • When editing an article only locale leaders and admins can change an article category. (Staging area, Knowledge Base, Live Chat, etc.)
  • When editing a staging copy, category cannot be changed.

Fields that require entered data

  • Language
  • Summarize your edit and cite a reference

Options

  • Language: drop-down menu to select language (unknown language not allowed)
  • Category:
    • Administration (only available to admins and locale leaders)
    • How to contribute (only available to admins, locale leaders, and approvers)
    • Live Chat
    • Knowledge Base (only available to admins, locale leaders, and approvers)
    • Staging Area
    • Sandbox/Testing Area
  • This article applies to:
    • Firefox 2 - The content of this article applies to users of Firefox 2.x.
    • Firefox 3.0 - The content of this article applies to users of Firefox 3.0.x.
    • Firefox 3.1 - The content of this article applies to users of Firefox 3.1
  • Type of article:
    • Help article - This article is a reference chart, tutorial, or a how-to article.
    • Troubleshooting article - This article is for solving a problem.
  • Summarize your edit and cite a reference:
    • Mark other translations as out of date (only available on English articles)

Toolbar items

  • Bold
  • Italics
  • Wiki link
  • External link
  • Numbered list
  • List
  • H1
  • H2
  • H3
  • Menu path
  • Button
  • Kbd
  • File name/path
  • Pref name/value
  • Code
  • Note
  • Warning
  • Insert Image (will pop up prompt for:)
    • Image uploader (mandatory)
    • Image height
    • Image width
    • Alignment
  • SHOWFOR (will trigger a drop-down, that includes:)
    • Windows
    • Mac
    • Linux
    • Windows and Mac
    • Windows and Linux
    • Mac and Linux
    • –separator–
    • Firefox 3.1
    • Firefox 3.0
    • Firefox 3.0 and 3.1
    • Firefox 2
  • Dynamic Content (will trigger a drop-down that includes all content labels for the language assigned to the article)

Viewing options

Tabs at the bottom of content area will choose what you view.

  • Windows
  • Mac
  • Linux
  • Source (if you want to edit the tikiwiki markup)

Mockups

Technical Requirements

  • WYSIWYG editor {bug|454131}