Help310

Difference between revisions of "Help screens styleguide"

From Joomla! Documentation

m (1 revision: Initial import of 3.0 help screens (derived from 2.5 help screens))
(Several markup changes and some Words2Watch corrections.)
 
(202 intermediate revisions by 9 users not shown)
Line 1: Line 1:
{{RightTOC}}
+
<noinclude><languages /></noinclude>
[[Help30:Help_screens|Return to Joomla! 3.0 Help Screen Wiki Page]]
+
__NOEDITSECTION__
 +
[[<translate>
 +
<!--T:38-->
 +
<tvar name=1>S:MyLanguage/{{NAMESPACE}}:Help_screens</tvar>|Return to Joomla <tvar name=2>{{CurrentSTSVer|minor}}</tvar> Help Screen Wiki Page
 +
</translate>]]
  
This is a work in progress and should be used as a guideline for creating help screens for Joomla 3.0.  This offers consistency throughout the help screens to allow for easier navigation.  Feel free to add to this.
+
<translate>
 +
<!--T:39-->
 +
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.
  
==How to Access==
+
<!--T:40-->
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. You might think this is redundant because you must be on that screen in order to have retrieved the help screen, but actually 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.
+
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>
 +
{{Chunk30:Help_screen_Description_Header/<translate><!--T:116--> en</translate>}}
 +
<translate>
 +
<!--T:43-->
 +
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]].
  
Here's an example:
+
<!--T:44-->
{| style="margin-left:50px"
+
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.
|-  
 
|To access this screen:
 
* Select '''Extensions → Module Manager''' from the drop-down menus.
 
  
If there is more than one way to access the screen, list them all. For example:
+
<!--T:144-->
 +
Keep the description short and to the point. If the description is long, consider using bullet points to summarise it.
 +
</translate>
 +
{{Chunk30:Help_screen_How_To_Access_Header/<translate><!--T:117--> en</translate>}}
  
To access this screen you can either:
+
<translate>
* Click the '''Article Manager''' button in the [[Help30:Site Control Panel|Control Panel]], or
+
<!--T:46-->
* Select '''Content → Article Manager''' from the drop-down menus.
+
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.
|}
 
  
Notes:
+
<!--T:132-->
* 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.
+
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.
* You "click" on buttons, including toolbar buttons, but you "select" menu items.  Consistent use of this terminology should help users.
+
 
 +
<!--T:47-->
 +
Here is an example:
 +
</translate>
 +
{{Chunk30:Help_screen_How_To_Access_By_Menu/en|Content,Articles}}
 +
 
 +
<translate>
 +
<!--T:114-->
 +
Example's chunks and parameters:
 +
</translate>
 +
 
 +
*<tt><nowiki>{{Chunk30:Help_screen_How_To_Access_By_Menu/<translate>en</translate>|<translate>Content,Articles</translate>}}</nowiki></tt>{{-}}[[S:MyLanguage/JDOC:Using_chunks_in_Joomla_help_screens|<translate><!--T:141--> Learn more about using chunks in Joomla help screens.</translate>]]
 +
 
 +
<translate>
 +
<!--T:50-->
 +
Note:
  
==Description==
+
<!--T:52-->
This goes into more detail about what the screen does. 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.  If the description is long then consider using bullet points to summarise it.
+
* You "click" on buttons, including toolbar buttons, but you "select" menu items. Consistent use of this terminology should help users.
 +
</translate>
 +
{{Chunk30:Help_screen_Screenshot_Header/<translate><!--T:118--> en</translate>}}
  
==Screenshot==
+
<translate>
 +
<!--T:55-->
 
Screenshot showing the overall look of the screen.
 
Screenshot showing the overall look of the screen.
 +
</translate>
 +
 +
{{notice|title=<translate><!--T:143--> General Information</translate>|<translate><!--T:56--> Please always use screenshots with <tvar name=1><tt><nowiki>|800px</nowiki></tt></tvar> 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.</translate>}}
  
 +
<translate>
 +
<!--T:57-->
 
Notes:
 
Notes:
* Screenshot images should be no wider than 670 pixels so that they fit neatly in the popup help window size without horizontal scrolling.
 
* The filename should follow our standard naming conventions.  In this case it will be Help30-<menu system path in lowercase separated by dashes>-screen.png.  For example, <nowiki>[[Image:Help30-content-article manager-screen.png]]</nowiki> is the wiki markup for the screenshot of the Article Manager screen.
 
* You can use either .png or .jpg files.
 
  
==Toolbar==
+
<!--T:58-->
Obviously, this section should only be included on help screens where a toolbar is present.
+
* The filename should follow our [[#Image_naming_guidelines|Image naming guidelines]] for help screens.
 +
 
 +
<!--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.
  
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.
+
<!--T:61-->
 +
* You can use either ''.png'' or ''.jpg'' files.
 +
</translate>
 +
{{Chunk30:Help_screen_Column_Header/<translate><!--T:119--> en</translate>}}
  
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:
+
<translate>
* Instead of "To find buried treasures, click this button."
+
<!--T:63-->
** Say, "Finds buried treasures."
+
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.
* Instead of "You can click this button to insert a picture of John Stamos into the current document."
+
</translate>
** Say, "Inserts a picture of John Stamos."
+
{{Chunk30:Help_screen_Column_Filtering_Header/<translate><!--T:120--> en</translate>}}
* 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:
+
<translate>
Help<version>-Toolbar-<iconslist>.png
+
<!--T:133-->
where <iconslist> is a '-' separated list of the toolbar legends.  Each word should be capitalised, spaces and '&' removed.
+
This section describes the dropdown input fields above the column headers.
For example: Help30-Toolbar-New-Edit-Delete-Options-Help.png
+
</translate>
 +
{{Chunk30:Help_screen_Details_Header/<translate><!--T:128--> en</translate>}}
  
==List Filters==
+
<translate>
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. See [[Screen.content.15#List_Filters]] for example from 1.5.
+
<!--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 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]].
  
==Column Headers==
+
<!--T:67-->
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.
+
If fields are grouped into fieldsets or tabs then group the fields under sub-headings.
 +
</translate>
 +
{{Chunk30:Help_screen_List_Filters_Header/<translate><!--T:122--> en</translate>}}
  
==Form Fields==
+
<translate>
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 [[Help30:Content Article Manager Options]].
+
<!--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.
 +
</translate>
 +
{{Chunk30:Help_screen_List_Filters_Search_Tools/<translate><!--T:131--> en</translate>}}
  
If fields are grouped into fieldsets or tabs then group the fields under sub-headings.
+
<translate>
 +
<!--T:134-->
 +
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>
 +
{{Chunk30:Help_screen_Automatic_Pagination_Header/<translate><!--T:123--> en</translate>}}
 +
 
 +
<translate>
 +
<!--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.
 +
</translate>
 +
{{Chunk30:Help_screen_Toolbar_Header/<translate><!--T:124--> en</translate>}}
 +
 
 +
<translate>
 +
<!--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. It is best to provide a picture of the toolbar.
 +
 
 +
<!--T:145-->
 +
'''Button Description'''
 +
 
 +
<!--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''. 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-->
 +
For instance:
 +
</translate>
 +
 
 +
<translate>
 +
<!--T:76-->
 +
* Instead of <tvar name=1>"To find buried treasures, click this button."</tvar>
 +
</translate>
 +
<translate>
 +
<!--T:77-->
 +
** Say, <tvar name=1>''"Finds buried treasures."''</tvar>
 +
</translate>
 +
 
 +
<translate>
 +
<!--T:78-->
 +
* Instead of <tvar name=1>"You can click this button to insert a picture of John Stamos into the current document."</tvar>
 +
</translate>
 +
<translate>
 +
<!--T:79-->
 +
** Say, <tvar name=1>''"Inserts a picture of John Stamos."''</tvar>
 +
</translate>
 +
 
 +
<translate>
 +
<!--T:80-->
 +
* Instead of <tvar name=1>"Inform yourself that a picture of John Stamos is the same thing as a buried treasure."</tvar>
 +
</translate>
 +
<translate>
 +
<!--T:81-->
 +
** Say, <tvar name=1>''"Informs you that a picture of John Stamos is the same thing as buried treasure."''</tvar>
 +
</translate>
 +
 
 +
<translate>
 +
<!--T:146-->
 +
'''Image File Naming Convention'''
 +
 
 +
<!--T:82-->
 +
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.
 +
 
 +
<!--T:83-->
 +
Toolbar images should follow this naming convention:
 +
</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>
  
==Options==
+
<translate>
This section should only be included on help screens where the screen has an Options toolbar button which opens a modal options sub-screen.  If there are many options and the help screen would become excessively long if they were to be described here, then link to a separate help screen with an "_Options" suffix.  For example, see [[Help30:Content Article Manager Options|Content Article Manager Options]].
+
<!--T:85-->
 +
Here is an example:
 +
</translate>
  
Since the Options modal screen is usually tabbed you should add a sub-section under this section for each tab. For example, if there is a tab labelled "Editing Layout" then you should add a third-level heading of that name and within that sub-section you should describe each of the available fields.  You should start each sub-section with a screenshot of the appropriate Options panel.
+
*<tt>Help32-Save-SaveClose-SaveNew-SaveAsCopy-Version-Close-toolbar-en.png</tt>
 +
{{Chunk30:Help_screen_Batch_Header/<translate><!--T:125--> en</translate>}}
  
==Batch Process==
+
<translate>
This section should only be included on help screens where the screen has a batch process feature. For example, see [[Help30:Components Banners Categories]].
+
<!--T:87-->
 +
This section should only be included on help screens that have a batch button.
 +
</translate>
 +
{{Chunk30:Help_screen_Quick_Tips_Header/<translate><!--T:126--> en</translate>}}
  
==Quick Tips==
+
<translate>
 +
<!--T:89-->
 
As the name suggests, this section should include tips, hints, suggestions that can assist a user in performing tasks involving the screen.
 
As the name suggests, this section should include tips, hints, suggestions that can assist a user in performing tasks involving the screen.
 +
</translate>
 +
{{Chunk30:Help_screen_Related_Information_Header/<translate><!--T:127--> en</translate>}}
 +
 +
<translate>
 +
<!--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 good reason.
 +
</translate>
 +
{{Chunk30:Help_screens_Header/<translate><!--T:136--> en</translate>}}
 +
 +
<translate>
 +
<!--T:137-->
 +
A table showing related Help screens.
 +
</translate>
 +
<translate>
 +
== Notes for Editors == <!--T:92-->
 +
</translate>
 +
 +
<translate>
 +
=== Modify the Help Screen === <!--T:96-->
 +
 +
<!--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 modify it:
 +
 +
<!--T:98-->
 +
* Is the status at the moment <tvar name=1>'Ready'</tvar> or <tvar name=2>'To be moved'</tvar>? Change it to <tvar name=3>'Modified by [name]'</tvar> (replace [name] for your username at the Joomla Docs Wiki)
 +
 +
<!--T:99-->
 +
* Is the status at the moment <tvar name=1>'To be reviewed'</tvar>? You don't have to change the status in that case.
 +
</translate>
 +
 +
<translate>
 +
===Image Naming Guidelines=== <!--T:100-->
 +
</translate>
 +
 +
<tt><nowiki>Help30-[menu-system-path-separated_by_dashes]-[screenElementType]-en.png</nowiki></tt>
 +
<translate>
 +
<!--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 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.
 +
</translate>
 +
<translate>
 +
<!--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>
 +
** ''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>
 +
** ''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:107-->
 +
'''Examples Using the Guidelines:'''
 +
</translate>
 +
<translate>
 +
<!--T:108-->
 +
* A screenshot of the Extension Manager's "Discover" screen would be named:
 +
</translate>
 +
*:<tt>Help30-extensions-manage-discover-screen-en.png</tt>
  
==Related Information==
+
<translate>
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.
+
<!--T:109-->
 +
* A screenshot of the Extension Manager's "Discover" screen toolbar would be named:
 +
</translate>
 +
*:<tt>Help30-extensions-manage-discover-toolbar-en.png</tt>
  
==Notes for help screen editors==
+
<noinclude>
*[[Help screen layout|Layout of a typical Help Screen]]
+
[[Category:Style guides|{{PAGENAME}}]]
*Overview of [{{fullurl:Special:Allpages|namespace=136}} Help screen chunks]<br/>For usage information and examples see the following templates:
+
</noinclude>
** {{tlx|colheader|Column name}} includes one of the ''Help screen column header XYZ'' chunks
 
** {{[[Chunk30:colheader|Chunk30:colheader|Column name]]}} includes one of the ''Help screen column header XYZ'' chunks for version {{JVer|3.0}}
 
** [[Using_chunks_in_Joomla_help_screens|Using chunks in Joomla help screens]] includes instructions for using and creating colheader chunks {{JVer|3.0}}
 
** {{tlx|toolbaricon|Action name}} is for ''Help screen toolbar XYZ''
 
** {{tlx|cpanelicon|Icon name}} is for ''Help screen icon XYZ''
 
** for proper categorisation read the instructions of {{tim|cathelp}}
 
* [[Content editors]]
 
** {{[[Chunk30:TinyMCE]]}} for TinyMCE
 
** {{[[Chunk30:No editor]]}} for No editor
 
* 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:
 
** help16-''[menu system path separated by dashes]''-''[screenElementType]''.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: help16-extension_manager-discover-screen.png
 
**** A screenshot of the Extension Manager's "Discover" screen tool bar would be named: help16-extension_manager-discover-toolbar.png
 
<noinclude>[[Category:Joomla! 3.0]]
 
[[Category:Style guides|{{PAGENAME}}]]</noinclude>
 
  
<noinclude>{{cathelp|3.0}}</noinclude>
+
<noinclude>{{cathelp|3.0,3.1,3.2,3.3,3.4,3.5,3.6,3.7,3.8,3.9,3.10}}</noinclude>

Latest revision as of 16: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