Difference between revisions of "Help screens styleguide"
From Joomla! Documentation
Coder4life (talk | contribs) |
Coder4life (talk | contribs) |
||
| Line 1: | Line 1: | ||
| + | [[Help16:Help_screens|Return to Help Screen Wiki Page]] | ||
| + | |||
This is a work in progress and should be used as a guideline for creating help screens for Joomla 1.6. This offers consistency throughout the help screens to allow for easier navigation. Feel free to add to this. | This is a work in progress and should be used as a guideline for creating help screens for Joomla 1.6. This offers consistency throughout the help screens to allow for easier navigation. Feel free to add to this. | ||
| − | '''Image Size''' : (Please add) | + | *'''Image Size''' : (Please add) |
| − | '''Wiki Image Tag''' : [[Image:imagename.png,jpeg]] | + | *'''Wiki Image Tag''' : <nowiki>[[Image:imagename.png,jpeg]]</nowiki> |
| − | '''Chunck Tag''' : (Please add) | + | *'''Chunck Tag''' : (Please add) |
| Line 16: | Line 18: | ||
==Description== | ==Description== | ||
| − | This goes into more detail about what the component does. There should be no specific format to this section because the description should be in direct | + | This goes into more detail about what the component does. There should be no specific format to this section because the description should be in direct correlation with the purpose and functionalitly of the component. There may be many subsections to the description that describe more specific details, best to be outlined through the use of bullet points. |
==Screenshot== | ==Screenshot== | ||
| Line 22: | Line 24: | ||
==Toolbar== | ==Toolbar== | ||
| − | Describes the available icons and their associated functions for this screen in the | + | Describes the available icons and their associated functions in the toolbar for this screen in the. Use '''chuncks''' here because many will be the same for different screens. Best to provide a picture of the toolbar. |
==Outline== | ==Outline== | ||
| Line 28: | Line 30: | ||
==Quick Tips== | ==Quick Tips== | ||
| − | Gives some advice to a person, recommends the best options based on a wide audience of | + | Gives some advice to a person, recommends the best options based on a wide audience of developers. |
==Related Information== | ==Related Information== | ||
| − | Should connect other pages of the Help Wiki. | + | Should connect other pages of the [[Help16:Help_screens|Help Wiki]]. |
Revision as of 16:01, 14 May 2010
Return to Help Screen Wiki Page
This is a work in progress and should be used as a guideline for creating help screens for Joomla 1.6. This offers consistency throughout the help screens to allow for easier navigation. Feel free to add to this.
- Image Size : (Please add)
- Wiki Image Tag : [[Image:imagename.png,jpeg]]
- Chunck Tag : (Please add)
Overview[edit]
How is this related to Joomla! Is it a component can be accessed from the front-end and/or back of Joomla!?
How to Access[edit]
The path taken to get to the screen.
- Select (menu item) → (submenu item) → (ect.) from the drop-down menu of the Joomla! Administrator Panel.
Description[edit]
This goes into more detail about what the component does. There should be no specific format to this section because the description should be in direct correlation with the purpose and functionalitly of the component. There may be many subsections to the description that describe more specific details, best to be outlined through the use of bullet points.
Screenshot[edit]
Screenshot overall look of the page.
Toolbar[edit]
Describes the available icons and their associated functions in the toolbar for this screen in the. Use chuncks here because many will be the same for different screens. Best to provide a picture of the toolbar.
Outline[edit]
Describes the available options for this screen. There may be many links within this screen that group together certain options. Break down these linked screens into separte sub-heads and outline their individual functions. It is also a good idea to include screenshots of these linked screens because their options will be most likely differenet.
Quick Tips[edit]
Gives some advice to a person, recommends the best options based on a wide audience of developers.
Related Information[edit]
Should connect other pages of the Help Wiki.