Joomla! Doc Sprints/Start Here
From Joomla! Documentation
< JDOC:Joomla! Doc Sprints
Below is a list of tasks, categorised by intended audience. There will be overlap so treat this as a rough guide only. Please feel free to add new topics to this list.
To start writing on a topic, change the item in this list into a link (unless it's already a link of course!). To do this you simply surround the text by a pair of square brackets. For example, to make "text" into a link, change it to "[[text]]". Save your change. The link text should now appear in red. Click on this new link and you will be taken to an editor screen for the new page. Enter your new topic text and click save. Simple as that. If you encounter any problems, ask for help on the IRC channel.
When you begin editing a page please add {{inuse}} to the top of the page before you start working on it so that others do not create conflicting changes to the same page. And don't forget to remove it again when you have finished! Thank you.
- If you are new to MediaWiki then you should consult the User's Guide for information on using the wiki software.
- List of local wiki templates that can be used in your wiki pages. Templates reduce repetition and are the basis of modular documentation.
- List of local wiki extensions that have been installed on this wiki. Extensions provide additionally functionality to the wiki such as syntax highlighting and conditional expressions.
- List of local interwiki links that are available on this wiki. These provide useful shortcuts to creating URLs to other websites including the Joomla! forum, help screens and issue tracker; as well as links to the PHP documentation or Wikipedia.
- Please read the Joomla! Editorial Style Guide and the list of words to watch.
Where to start[edit]
Looking for a topic to write about? At this point, please consider helping complete an article under construction first.
For small tasks look in the Cookie Jar (below). There are category lists about many topics of need on docs, here are a few:
- Articles that require a review are awaiting a second opinion or a review for accuracy.
- Article in need of improvement require more information to make them useful.
- Article in need of completion were started, have come a long way but are not quite finished yet.
Otherwise, look down this page and browse the links.
Doc Camp Cookie Jar[edit]
This is a list of small tasks that should be quick to get done and might be a good introduction to working on the documentation. These are a list of pages which are added manually.
This is a list of pages added auto-magically in need of copyediting in general.
List of all articles belonging to the "Needs copyediting" category. They really just need another editor to review them quickly or upload appropriate images.
Under Construction[edit]
Articles which are under construction and need help getting to the review point.
List of all articles belonging to the category "Under Construction"
- Controllers
- GSoD 2023
- GSoD 2023 Project Ideas
- Models
- Testing Joomla Extensions with Codeception
- Views
Documentation Help by Audiences[edit]
Users/Administrators[edit]
Users are visitors to a Joomla! website; administrators are people who install and maintain the website. The assumption is that these people will not know how to write code.
List of all articles belonging to the categories "Need review" AND "Management(Adminstration)"
- Adding a new menu item/da
- Adding a new menu item/de
- Adding a new menu item/el
- Adding a new menu item/en
- Adding a new menu item/et
- Adding a new menu item/fr
- Adding a new menu item/nl
- Adding a new menu item/pt
- Adding a new user/be
- Adding a new user/bn
- Adding a new user/de
- Adding a new user/el
- Adding a new user/en
- Adding a new user/es
- Adding a new user/et
- Adding a new user/fr
- Adding a new user/nl
- Adding a new user/pt
- Adding a new user/pt-br
- Adding a new user/ro
- Adding a new user/ru
Web Designers[edit]
Web designers are those people tasked with creating a Joomla! website that will later be looked after by an administrator. These people can be assumed to know about HTML and CSS but may have only minimal knowledge of PHP.
List of all articles belonging to the categories "Need review" AND "Template specific article"
- Access Template Manager Customisation/es
- Distributing Joomla! templates
- File structure for packaging
- Getting Started with Templates/es
- Location of template language definition files
- Location of template language definition files
- Location of template language definition files/en
- Location of template language definition files/es
- Location of template language definition files/fr
- Location of template language definition files/nl
- Making templates translatable
- Making templates translatable/en
- Making templates translatable/es
- Making templates translatable/fr
- Making templates translatable/zh-tw
- Using Class Suffixes
Core Developers[edit]
By "core developers" we mean developers who are contributing to the Joomla! core distribution which includes the core extensions as well as the Framework.
List of all articles belonging to the categories "Need review" AND "Core or Bug Squad"
Third-party Developers[edit]
By "third-party developers" we mean developers who are working on extensions to Joomla! (components, modules, plugins and templates) which are made available separately from the Joomla! distribution.
List of all articles belonging to the categories "Need review" AND "Extension developers"
- Creating a custom form field type
- Creating a custom form field type/de
- Creating a custom form field type/en
- Creating a custom form field type/es
- Creating a custom form field type/fr
- Creating a custom form field type/nl
- Extension types (general definitions)/es
- Languages: Edit Content Language
- Languages: Edit Content Language
- Languages: Edit Content Language/en
- Languages: Edit Content Language/en
- Languages: Edit Content Language/nl
- Languages: Edit Content Language/nl
Testers[edit]
These people may be testing functionality from a user perspective; or they may be developers testing the code itself.
List of all articles belonging to the categories "Need review" AND "Testing"
Documentors[edit]
This is meta documentation for use by the Documentation Working Group and other documentors.