JDOC:Joomla! Doc Sprints/Start Here

Reference Information

• 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.

Below is a list of articles in need of some attention, then categorised by intended audience. There will be overlap so treat these lists as a rough guide only.

Remember, if you want to help with translation of our documentation you should go to the page specifically for Documentation Translators and sign up. We have over 60 active contributors helping translate our documentation! Join the group and have some fun but don't delay, there are a few tasks you need to complete. You will get translator approval, a friendly welcome message, and added to the group chat for translators. There are lots of great people willing to help get you started.

Please Remember

Where to start

Looking for a topic to write about? Please consider helping complete an article under construction listed here first before creating any new articles.

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

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.

• Register globals
• Using an FTP client to upload files
• Using a terminal session

This is a list of pages added auto-magically in need of copyediting in general so they can be moved to translation status.

List of all articles belonging to the "Needs copyediting" category. They really just need another editor to review them quickly or upload appropriate images.

• Adding custom fields/Parameters for all Custom Fields 
• Using Tags in an Extension/pt 

Documentation Help by Audiences

Below you will find a listing of articles which need attention. They are broken down by the Audience Type, which means the level of knowledge needed to review the article.

Users/Administrators

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

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

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"

• Browser Shortcut Issue Tracker/fr 
• Testing Joomla! patches/fr 

Third-party Developers

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

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"

• Testing Joomla Extensions with Codeception 

Under Construction

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 

Documentors

This is meta documentation for use by the Documentation Working Group and other documentors.

• MediaWiki setup notes