Help310

Difference between revisions of "Help screens styleguide"

From Joomla! Documentation

m
(Several markup changes and some Words2Watch corrections.)
 
(One intermediate revision by one other user not shown)
Line 11: Line 11:
  
 
<!--T:40-->
 
<!--T:40-->
If you have a question, please post in on the associated talk page of the help screen by clicking "Actions<tvar name=1>{{rarr|size=1}}</tvar>Discussion" buttons.
+
If you have a question, please post in on the associated talk page of the help screen by clicking ''Actions<tvar name=1>{{rarr|size=1}}</tvar>Discussion'' buttons.
 
</translate>
 
</translate>
 
{{Chunk30:Help_screen_Description_Header/<translate><!--T:116--> en</translate>}}
 
{{Chunk30:Help_screen_Description_Header/<translate><!--T:116--> en</translate>}}
 
<translate>
 
<translate>
 
<!--T:43-->
 
<!--T:43-->
Each and every help screen should begin with a '''Description''' section. This goes into more detail about what the screen does. [[<tvar name=1>S:MyLanguage/{{NAMESPACE}}:Menus_Menu_Manager</tvar>|Here is an use example]].
+
Every help screen should begin with a '''Description''' section. This goes into detail about what the screen does. [[<tvar name=1>S:MyLanguage/{{NAMESPACE}}:Menus_Menu_Manager</tvar>|Here is an use example]].
  
 
<!--T:44-->
 
<!--T:44-->
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.  
+
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 specific details.
  
 
<!--T:144-->
 
<!--T:144-->
Try to keep the description short and to the point, if the description is long then consider using bullet points to summarise it.
+
Keep the description short and to the point. If the description is long, consider using bullet points to summarise it.
 
</translate>
 
</translate>
 
{{Chunk30:Help_screen_How_To_Access_Header/<translate><!--T:117--> en</translate>}}
 
{{Chunk30:Help_screen_How_To_Access_Header/<translate><!--T:117--> en</translate>}}
Line 28: Line 28:
 
<translate>
 
<translate>
 
<!--T:46-->
 
<!--T:46-->
Each and every help screen should have 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.
+
Every help screen should have a '''How to Access''' section listing 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.
  
 
<!--T:132-->
 
<!--T:132-->
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.
+
Remember, the help screens can be retrieved in 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.
  
 
<!--T:47-->
 
<!--T:47-->
Line 50: Line 50:
  
 
<!--T:52-->
 
<!--T:52-->
* You "click" on buttons, including toolbar buttons, but you "select" menu items. Consistent use of this terminology should help users.
+
* You "click" on buttons, including toolbar buttons, but you "select" menu items. Consistent use of this terminology should help users.
 
</translate>
 
</translate>
 
{{Chunk30:Help_screen_Screenshot_Header/<translate><!--T:118--> en</translate>}}
 
{{Chunk30:Help_screen_Screenshot_Header/<translate><!--T:118--> en</translate>}}
Line 69: Line 69:
  
 
<!--T:60-->
 
<!--T:60-->
* The filename should always include a language code at the end of the name, for English <tvar name=1><tt>-en</tt></tvar> is added.
+
* The filename should always include a language code at the end of the name. For English, <tvar name=1><tt>-en</tt></tvar> is added.
  
 
<!--T:61-->
 
<!--T:61-->
* You can use either .png or .jpg files.
+
* You can use either ''.png'' or ''.jpg'' files.
 
</translate>
 
</translate>
 
{{Chunk30:Help_screen_Column_Header/<translate><!--T:119--> en</translate>}}
 
{{Chunk30:Help_screen_Column_Header/<translate><!--T:119--> en</translate>}}
Line 78: Line 78:
 
<translate>
 
<translate>
 
<!--T:63-->
 
<!--T:63-->
This section should only be included on help screens that describe backend screens; that is, where you have a list of items being shown. This section should describe each of the list columns.
+
This section should only be included on help screens that describe Backend screens; that is, where you have a list of items being shown. This section should describe each of the list columns.
 
</translate>
 
</translate>
 
{{Chunk30:Help_screen_Column_Filtering_Header/<translate><!--T:120--> en</translate>}}
 
{{Chunk30:Help_screen_Column_Filtering_Header/<translate><!--T:120--> en</translate>}}
Line 84: Line 84:
 
<translate>
 
<translate>
 
<!--T:133-->
 
<!--T:133-->
This section describes the dropdown input fields above the column headers.  
+
This section describes the dropdown input fields above the column headers.
 
</translate>
 
</translate>
 
{{Chunk30:Help_screen_Details_Header/<translate><!--T:128--> en</translate>}}
 
{{Chunk30:Help_screen_Details_Header/<translate><!--T:128--> en</translate>}}
Line 90: Line 90:
 
<translate>
 
<translate>
 
<!--T:66-->
 
<!--T:66-->
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 [[<tvar name=1>{{NAMESPACE}}:Site_Global_Configuration</tvar>|Site Global Configuration]] or [[<tvar name=2>{{NAMESPACE}}:Components_Article_Manager_Options</tvar>|Article Options]].
+
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 such as [[<tvar name=1>{{NAMESPACE}}:Site_Global_Configuration</tvar>|Site Global Configuration]] and [[<tvar name=2>{{NAMESPACE}}:Components_Article_Manager_Options</tvar>|Article Options]].
  
 
<!--T:67-->
 
<!--T:67-->
Line 99: Line 99:
 
<translate>
 
<translate>
 
<!--T:69-->
 
<!--T:69-->
This section should only be included on help screens that describe backend 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.  
+
This section should only be included on help screens that describe Backend 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.
 
</translate>
 
</translate>
 
{{Chunk30:Help_screen_List_Filters_Search_Tools/<translate><!--T:131--> en</translate>}}
 
{{Chunk30:Help_screen_List_Filters_Search_Tools/<translate><!--T:131--> en</translate>}}
Line 105: Line 105:
 
<translate>
 
<translate>
 
<!--T:134-->
 
<!--T:134-->
Most of these help screens have search tools to filter by status, access, … Include a picture of the dropdown list boxes and describe each of them. [[<tvar name=1>S:MyLanguage/{{NAMESPACE}}:Components_Banners_Tracks</tvar>#Search_Tools|Here is an use example]].
+
Most of these help screens have search tools to filter by status, access and so on. Include a picture of the dropdown list boxes and describe each of them. [[<tvar name=1>S:MyLanguage/{{NAMESPACE}}:Components_Banners_Tracks</tvar>#Search_Tools|Here is an use example]].
 
</translate>
 
</translate>
 
{{Chunk30:Help_screen_Automatic_Pagination_Header/<translate><!--T:123--> en</translate>}}
 
{{Chunk30:Help_screen_Automatic_Pagination_Header/<translate><!--T:123--> en</translate>}}
Line 111: Line 111:
 
<translate>
 
<translate>
 
<!--T:135-->
 
<!--T:135-->
This section should only be included on help screens that describe backend screens; that is, where you have a list of items being shown.
+
This section should only be included on help screens that describe Backend screens; that is, where you have a list of items being shown.
 
</translate>
 
</translate>
 
{{Chunk30:Help_screen_Toolbar_Header/<translate><!--T:124--> en</translate>}}
 
{{Chunk30:Help_screen_Toolbar_Header/<translate><!--T:124--> en</translate>}}
Line 117: Line 117:
 
<translate>
 
<translate>
 
<!--T:72-->
 
<!--T:72-->
Obviously, this section should only be included on help screens where a toolbar is present. Describes the available buttons and their associated functions. Best to provide a picture of the toolbar.
+
Obviously, this section should only be included on help screens where a toolbar is present. Describes the available buttons and their associated functions. It is best to provide a picture of the toolbar.
  
 
<!--T:145-->
 
<!--T:145-->
'''Button description'''
+
'''Button Description'''
  
 
<!--T:74-->
 
<!--T:74-->
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.
+
The first word should always be a verb and, unless it is an irregular verb, it should also end in the letter ''s''. 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.
  
 
<!--T:75-->
 
<!--T:75-->
Line 158: Line 158:
 
<translate>
 
<translate>
 
<!--T:146-->
 
<!--T:146-->
'''Image file naming convention'''
+
'''Image File Naming Convention'''
  
 
<!--T:82-->
 
<!--T:82-->
Line 166: Line 166:
 
Toolbar images should follow this naming convention:
 
Toolbar images should follow this naming convention:
 
</translate>
 
</translate>
'Help32-<iconslist>-toolbar-en.png'. <translate><!--T:147--> <tvar name=1><tt><iconslist></tt></tvar> is a <tvar name=2><tt>-</tt></tvar> separated list of the toolbar legends. Each word should be capitalised, spaces and <tvar name=3><tt>&</tt></tvar> removed.</translate>
+
'Help32-<iconslist>-toolbar-en.png'. <translate><!--T:147--> <tvar name=1><tt><iconslist></tt></tvar> is a <tvar name=2><tt>-</tt></tvar> separated list of the toolbar legends. Each word should be capitalised with spaces and <tvar name=3><tt>&</tt></tvar> removed.</translate>
  
 
<translate>
 
<translate>
Line 190: Line 190:
 
<translate>
 
<translate>
 
<!--T:91-->
 
<!--T:91-->
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.
+
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 good reason.
 
</translate>
 
</translate>
 
{{Chunk30:Help_screens_Header/<translate><!--T:136--> en</translate>}}
 
{{Chunk30:Help_screens_Header/<translate><!--T:136--> en</translate>}}
Line 199: Line 199:
 
</translate>
 
</translate>
 
<translate>
 
<translate>
== Notes for editors == <!--T:92-->
+
== Notes for Editors == <!--T:92-->
 
</translate>
 
</translate>
  
Line 206: Line 206:
  
 
<!--T:97-->
 
<!--T:97-->
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:
+
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 modify it:
  
 
<!--T:98-->
 
<!--T:98-->
Line 216: Line 216:
  
 
<translate>
 
<translate>
===Image naming guidelines=== <!--T:100-->
+
===Image Naming Guidelines=== <!--T:100-->
 
</translate>
 
</translate>
  
Line 222: Line 222:
 
<translate>
 
<translate>
 
<!--T:101-->
 
<!--T:101-->
* Replace <tvar name=1><tt>[menu-system-path-separated_by_dashes]</tt></tvar> with the names of the menu items that you would need to select to get to the item you are taking a screenshot of.</translate>{{-}}<translate><!--T:138--> Separate menu items with a dash <tvar name=1><tt>-</tt></tvar> and if the menu item name has more than one word in it, then separate the words with an underscore <tvar name=2><tt>_</tt></tvar>.</translate>{{-}}<translate><!--T:139-->
+
* Replace <tvar name=1><tt>[menu-system-path-separated_by_dashes]</tt></tvar> with the names of the menu items that you would need to select to get to the item you are taking a screenshot of.</translate>{{-}}<translate><!--T:138--> Separate menu items with a hyphen <tvar name=1><tt>-</tt></tvar> and if the menu item name has more than one word in it, separate the words with an underscore <tvar name=2><tt>_</tt></tvar>.</translate>{{-}}<translate><!--T:139-->
 
Do not use spaces in your file name. Replace spaces with the underscore <tvar name=1><tt>_</tt></tvar> character.
 
Do not use spaces in your file name. Replace spaces with the underscore <tvar name=1><tt>_</tt></tvar> character.
 
</translate>
 
</translate>
Line 228: Line 228:
 
<!--T:102-->
 
<!--T:102-->
 
* Replace <tvar name=1><tt>[screenElementType]</tt></tvar> with the type of the screen element that your picture contains.</translate>{{-}}<translate><!--T:140--> Screen element types are:</translate>
 
* Replace <tvar name=1><tt>[screenElementType]</tt></tvar> with the type of the screen element that your picture contains.</translate>{{-}}<translate><!--T:140--> Screen element types are:</translate>
** ''screen:''<translate><!--T:103--> This is a screenshot of the entire menu item.</translate>
+
** ''screen:'' <translate><!--T:103--> This is a screenshot of the entire menu item.</translate>
** ''toolbar:''<translate><!--T:104--> This is a picture of the menu item's toolbar.</translate>
+
** ''toolbar:'' <translate><!--T:104--> This is a picture of the menu item's toolbar.</translate>
** ''menu:''<translate><!--T:105--> This is a picture of the menu item's menu bar.</translate>
+
** ''menu:'' <translate><!--T:105--> This is a picture of the menu item's menu bar.</translate>
 
<translate><!--T:106--> *: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.</translate>
 
<translate><!--T:106--> *: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.</translate>
  
 
<translate>
 
<translate>
 
<!--T:107-->
 
<!--T:107-->
'''Examples using the guidelines:'''
+
'''Examples Using the Guidelines:'''
 
</translate>
 
</translate>
 
<translate>
 
<translate>

Latest revision as of 15:09, 15 October 2022

Other languages:
Deutsch • ‎English

Return to Joomla 3.10 Help Screen Wiki Page

This should be used as a guideline for creating Help screens. 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.

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

Description

Every help screen should begin with a Description section. This goes into detail about what the screen does. 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 specific details.

Keep the description short and to the point. If the description is long, consider using bullet points to summarise it.

How to Access

Every help screen should have a How to Access section listing 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 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 is an example:

  • Select Content  Articles from the dropdown menu of the Administrator Panel

Example's chunks and parameters:

Note:

  • You "click" on buttons, including toolbar buttons, but you "select" menu items. Consistent use of this terminology should help users.

Screenshot

Screenshot showing the overall look of the screen.

Info non-talk.png
General Information

Please always use screenshots with |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.

Notes:

  • 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 Backend screens; that is, where you have a list of items being shown. This section should describe each of the list columns.

Column Filters

This section describes the dropdown input fields above the column headers.

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 such as Site Global Configuration and Article 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 Backend 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.

Search Tools

Most of these help screens have search tools to filter by status, access and so on. Include a picture of the dropdown list boxes and describe each of them. Here is an use example.

Automatic Pagination

This section should only be included on help screens that describe Backend screens; that is, where you have a list of items being shown.

Toolbar

Obviously, this section should only be included on help screens where a toolbar is present. Describes the available buttons and their associated functions. It is best to provide a picture of the toolbar.

Button Description

The first word should always be a verb and, unless it is an irregular verb, it should also end in the letter s. 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."

Image File Naming Convention

Since many toolbars are the same across multiple screens, the image file naming convention for toolbars is aimed at making it easy to re-use toolbar images wherever possible.

Toolbar images should follow this naming convention: 'Help32-<iconslist>-toolbar-en.png'. <iconslist> is a - separated list of the toolbar legends. Each word should be capitalised with spaces and & removed.

Here is an example:

  • Help32-Save-SaveClose-SaveNew-SaveAsCopy-Version-Close-toolbar-en.png

Batch Process

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

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 good reason.

Help Screens

A table showing related Help screens.

Notes for Editors

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 modify 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 Naming Guidelines

Help30-[menu-system-path-separated_by_dashes]-[screenElementType]-en.png

  • 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 hyphen - and if the menu item name has more than one word in it, 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 toolbar.
    • 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 Guidelines:

  • A screenshot of the Extension Manager's "Discover" screen would be named:
    Help30-extensions-manage-discover-screen-en.png
  • A screenshot of the Extension Manager's "Discover" screen toolbar would be named:
    Help30-extensions-manage-discover-toolbar-en.png