Help39

Help screens styleguide

From Joomla! Documentation

This page contains changes which are not marked for translation.

Return to Joomla! 3.9 Help Screen Wiki Page

This is a work in progress and should be used as a guideline for creating Help screens for Joomla 3.x. The help screens which exist on the Joomla! Docs Wiki are being accessed by every Joomla! installation using the default help system. By following this styleguide, the Joomla! Project can offer consistency throughout the help screens to allow for easier navigation.

Info non-talk.png
General Information

Please always use screenshots with the suffix -en and |800px in the code whenever they are large. This way any size can be added and it will help translators to be able to add transcreated images without having to notice the width.

If you have a question, please post in on the associated talk page of the help screen by clicking the Discussion tab at the top of the help screen page.

Help Screen Page Layout

Description

Each and every help screen should have a "Description" section. This goes into more detail about what the screen does and is used in help screen tables throughout this wiki. Here is an use example.

There is no specific format to this section because the description should be in direct correlation with the purpose and functionality of the screen. There may be subsections to the description that describe more specific details. Try to keep the description short and to the point, if the description is long then consider using bullet points to summarise it.

How to Access

Each and every help screen should begin with a "How to access" section that gives the steps required to reach the screen that is being described. This might be redundant because a user must be on the administrator screen in order to have retrieved the help screen. Remember, the help screens can be retrieved in a number of different ways. For example, someone using a search engine to find out how to do something might come across a help screen on the wiki without ever having accessed the help system.

Here's an example:

  • Click the Articles icon in the Control Panel
  • Select Content  Articles from the drop-down menu of the Joomla! Administrator Panel.
  • Click the Articles link while viewing Categories, Featured Articles or another link in the sidebar.

Note:

  • If the way to reach the screen is from another screen then the name of that screen should be a link to its help screen.
  • You "click" on buttons, including toolbar buttons, but you "select" menu items. Consistent use of this terminology should help users.
  • For ease of rendering the right arrow(  ), This pointing  at that see the {{rarr}} template for use. It was designed to make help screen How to Access instructions easy to write.

Screenshot

Screenshot showing the overall look of the screen.

Notes:

  • Screenshot images can be any width, but larger images should have the |800px added in the source.
  • The filename should follow our standard naming conventions for help screens.
    Help-3x-<menu system-path-in-lowercase-separated-by-dashes>-screen-en.png.
    For example, a screenshot of the Article Manager screen would be [[File:Help-3x-content-article-manager-screen-en.png]].
  • The filename should always include a language code at the end of the name, for English -en is added.
  • You can use either .png or .jpg files.

Column Headers

This section should only be included on help screens that describe back-end manager screens; that is, where you have a list of items being shown. This section should describe each of the list columns.

Column Filtering

{{Chunk30:Column_Filtering_Sort_Number/<translate>en</translate>}}

[[Image:Help30-colheader-Column-filter---number-en.png]]{{-}}

{{Chunk30:Column_Filtering_Sort_Number_Description/en}}

{{Chunk30:colheader|Order/<translate>en</translate>}}

{{Chunk30:colheader|Ascending/<translate>en</translate>}}

{{Chunk30:colheader|DisplayNum/<translate>en</translate>}}

Details

This section should only be included on help screens that describe screens which include a form. This includes all the add/edit screens, but also includes screens like Help30:Site Global Configuration and modal popups like Help31:Components Article Manager Options. If fields are grouped into fieldsets or tabs then group the fields under sub-headings.

List Filters

This section should only be included on help screens that describe back-end manager screens; that is, where you have a list of items being shown. This section should describe how to use the list filters to filter the contents of the screen.

Automatic Pagination

{{Chunk30:colheader|Manager Pagination/<translate>en</translate>}}

Toolbar

Obviously, this section should only be included on help screens where a toolbar is present.

Describes the available buttons and their associated functions. Use chunks here because many will be the same for different screens. Best to provide a picture of the toolbar.

The first word should always be a verb and, unless it is an irregular verb, it should also end in the letter "s". This means you should structure the description as if you are using the word "this" as the subject, but leave the subject out of the sentence. This will make the sentence actually a sentence fragment. For instance:

  • Instead of "To find buried treasures, click this button."
    • Say, "Finds buried treasures."
  • Instead of "You can click this button to insert a picture of John Stamos into the current document."
    • Say, "Inserts a picture of John Stamos."
  • Instead of "Inform yourself that a picture of John Stamos is the same thing as a buried treasure."
    • Say, "Informs you that a picture of John Stamos is the same thing as buried treasure."

Since many toolbars are the same across multiple screens, the image filenaming convention for toolbars is aimed at making it easy to re-use toolbar images wherever possible. Toolbar images should follow this naming convention: Help<version>-Toolbar-<iconslist>.png where <iconslist> is a '-' separated list of the toolbar legends. Each word should be capitalised, spaces and '&' removed. For example: Help30-Toolbar-New-Edit-Delete-Options-Help.png

Batch Process

This section should only be included on help screens that have a batch button.

{{Chunk30:Help_screen_column_header_Batch_Process_Description/en}}

:[[Image:Help30-colheader-batch-process--en.png]]

{{Chunk30:Help screen column header Batch Process Change Value Note/<translate>en</translate>}}

{{Chunk30:Help screen column header Batch Process How To/<translate>en</translate>}}

Chunk30:Help screen column header Batch Process Change Language Access/<translate>en</translate>

Chunk30:Help screen column header Batch Process Change Category Group/<translate>en</translate>

Chunk30:Help screen column header Batch Process Change Tag/<translate>en</translate>

Chunk30:Help screen column header Batch Process Message Note/<translate>en</translate>

Chunk30:Help screen column header Batch Process Clear Selection/<translate>en</translate>

Quick Tips

As the name suggests, this section should include tips, hints, suggestions that can assist a user in performing tasks involving the screen.

Related Information

Generally this should be a list of links to further or related information. All links should be to pages on this wiki. No external links without very good reason.

Notes for help screen editors

Help screen chunks

For usage information and examples see the following templates:

Modify the Help Screen

Did you notice a mistake or do think it's useful to add some extra information? You're welcome to modify the Help Screen. Please change the status of the modified Help Screen after you modified it:

  • Is the status at the moment 'Ready' or 'To be moved'? Change it to 'Modified by [name]' (replace [name] for your username at the Joomla! Docs Wiki)
  • Is the status at the moment 'To be reviewed'? You don't have to change the status in that case.

Image file naming convention

help30-[menu system path separated by dashes]-[screenElementType]-en.png,jpg

  • Replace [menu system path separated by dashes] with the names of the menu items that you would need to select to get to the item you are taking a screenshot of. Separate menu items with a dash (-) and if the menu item name has more than one word in it, then separate the words with an underscore (_). Do not use spaces in your file name. Replace spaces with the underscore (_) character.
  • Replace [screenElementType] with the type of the screen element that your picture contains. Screen element types are:
    • screen - This is a screenshot of the entire menu item
    • toolbar - This is a picture of the menu item's tool bar.
    • menu - This is a picture of the menu item's menu bar.
Note: As more screen element types are needed, add them to this style guide so that help documentation developers can refer to this guide and stay consistent.
  • Examples using the image naming convention:
    • A screenshot of the Extension Manager's "Discover" screen would be named: help30-extension_manager-discover-screen-en.png
    • A screenshot of the Extension Manager's "Discover" screen tool bar would be named: help30-extension_manager-discover-toolbar-en.png