CINXE.COM
JDOC:How to Contribute to Joomla! Documentation - Joomla! Documentation
<!DOCTYPE html> <html class="client-nojs" lang="en" dir="ltr"> <head> <meta charset="UTF-8"/> <title>JDOC:How to Contribute to Joomla! Documentation - Joomla! Documentation</title> <script>document.documentElement.className="client-js";RLCONF={"wgBreakFrames":!1,"wgSeparatorTransformTable":["",""],"wgDigitTransformTable":["",""],"wgDefaultDateFormat":"dmy","wgMonthNames":["","January","February","March","April","May","June","July","August","September","October","November","December"],"wgRequestId":"81b49c8f2ddc29c1e45e6d7f","wgCSPNonce":!1,"wgCanonicalNamespace":"Project","wgCanonicalSpecialPageName":!1,"wgNamespaceNumber":4,"wgPageName":"JDOC:How_to_Contribute_to_Joomla!_Documentation","wgTitle":"How to Contribute to Joomla! Documentation","wgCurRevisionId":1027660,"wgRevisionId":1027660,"wgArticleId":29261,"wgIsArticle":!0,"wgIsRedirect":!1,"wgAction":"view","wgUserName":null,"wgUserGroups":["*"],"wgCategories":["Documentation Wiki Information","Volunteer Engagement"],"wgPageContentLanguage":"en","wgPageContentModel":"wikitext","wgRelevantPageName":"JDOC:How_to_Contribute_to_Joomla!_Documentation","wgRelevantArticleId":29261,"wgIsProbablyEditable":!1, "wgRelevantPageIsProbablyEditable":!1,"wgRestrictionEdit":[],"wgRestrictionMove":[],"wgMediaViewerOnClick":!0,"wgMediaViewerEnabledByDefault":!0,"wgULSAcceptLanguageList":[],"wgULSCurrentAutonym":"English","wgULSPosition":"personal","wgULSisCompactLinksEnabled":!0,"wgTranslatePageTranslation":"source"};RLSTATE={"site.styles":"ready","noscript":"ready","user.styles":"ready","user":"ready","user.options":"loading","ext.translate":"ready","ext.translate.tag.languages":"ready","skins.jforeground.styles":"ready","mediawiki.toc.styles":"ready","ext.uls.pt":"ready"};RLPAGEMODULES=["site","mediawiki.page.startup","mediawiki.page.ready","mediawiki.toc","skins.jforeground.js","mmv.head","mmv.bootstrap.autostart","ext.uls.compactlinks","ext.uls.interface","ext.translate.pagetranslation.uls"];</script> <script>(RLQ=window.RLQ||[]).push(function(){mw.loader.implement("user.options@1hzgi",function($,jQuery,require,module){/*@nomin*/mw.user.tokens.set({"patrolToken":"+\\","watchToken":"+\\","csrfToken":"+\\"}); });});</script> <link rel="stylesheet" href="/load.php?lang=en&modules=ext.translate%7Cext.translate.tag.languages%7Cext.uls.pt%7Cmediawiki.toc.styles%7Cskins.jforeground.styles&only=styles&skin=jforeground"/> <script async="" src="/load.php?lang=en&modules=startup&only=scripts&raw=1&skin=jforeground"></script> <meta name="ResourceLoaderDynamicStyles" content=""/> <link rel="stylesheet" href="/load.php?lang=en&modules=site.styles&only=styles&skin=jforeground"/> <meta name="generator" content="MediaWiki 1.35.10"/> <meta name="viewport" content="width=device-width, initial-scale=1.0, user-scalable=yes, minimum-scale=0.25, maximum-scale=5.0"/> <link rel="apple-touch-icon" href="/apple-touch-icon-precomposed.png"/> <link rel="shortcut icon" href="/favicon.ico"/> <link rel="search" type="application/opensearchdescription+xml" href="/opensearch_desc.php" title="Joomla! Documentation (en)"/> <link rel="EditURI" type="application/rsd+xml" href="//docs.joomla.org/api.php?action=rsd"/> <link rel="license" href="/JEDL"/> <link rel="alternate" type="application/atom+xml" title="Joomla! Documentation Atom feed" href="/index.php?title=Special:RecentChanges&feed=atom"/> <!--[if lt IE 9]><script src="/resources/lib/html5shiv/html5shiv.js"></script><![endif]--> </head> <body class="mediawiki ltr sitedir-ltr mw-hide-empty-elt ns-4 ns-subject page-JDOC_How_to_Contribute_to_Joomla_Documentation rootpage-JDOC_How_to_Contribute_to_Joomla_Documentation skin-jforeground action-view"><div id='navwrapper'> <!-- START FOREGROUNDTEMPLATE --> <div id="top-nav" class="fixed"> <nav id="topnav" class="top-bar top row"> <ul class="title-area"> <li class="name logo"> <a href="/Main_Page"> <img alt="Joomla! Documentation" src="/skins/jforeground/joomla_logo_small.png" style="max-width: 64px;height:auto; max-height:36px; display: inline-block; vertical-align:middle;"></a> </li> <li class="toggle-topbar menu-icon"> <a href="#"><span> </span></a> </li> </ul> <section class="top-bar-section"> <ul id="top-bar-left" class="left"> <li class="has-dropdown active" id="p-sidebar-Joomla"> <a href="#">Joomla!</a> <ul class="dropdown"> <li id="n-sidebar-Main"><a href="https://www.joomla.org"><i class="fa fa-joomla 2x-fa icon"></i>Joomla! Home</a></li> <li id="n-sidebar-What"><a href="https://www.joomla.org/about-joomla.html">What is Joomla?</a></li> <li id="n-sidebar-Benefits"><a href="https://www.joomla.org/core-features.html">Benefits & Features</a></li> <li id="n-sidebar-Leadership"><a href="https://www.joomla.org/about-joomla/the-project.html">Project & Leadership</a></li> <li id="n-sidebar-Trademark"><a href="https://tm.joomla.org">Trademark & Licensing</a></li> <li class="divider"></li> <li id="label"><label>Support Joomla!</label></li> <li id="n-sidebar-Contribute"><a href="https://www.joomla.org/contribute-to-joomla.html">Contribute</a></li> <li id="n-sidebar-Sponsorship"><a href="https://www.joomla.org/sponsor.html">Sponsor</a></li> <li id="n-sidebar-Partner"><a href="https://www.joomla.org/about-joomla/partners.html">Partner</a></li> <li id="n-sidebar-Shop"><a href="https://shop.joomla.org/">Shop</a></li> </ul> </li> <li class="has-dropdown active" id="p-sidebar-Extend"> <a href="#">Download & Extend</a> <ul class="dropdown"> <li id="n-sidebar-JoomlaCode"><a href="https://downloads.joomla.org/">Downloads</a></li> <li id="n-sidebar-Extensions"><a href="https://extensions.joomla.org/">Extensions</a></li> <li id="n-sidebar-Translations"><a href="https://community.joomla.org/translations.html">Languages</a></li> <li id="n-sidebar-Free-Hosted"><a href="https://launch.joomla.org">Get a free site</a></li> </ul> </li> <li class="has-dropdown active" id="p-sidebar-About"> <a href="#">Discover & Learn</a> <ul class="dropdown"> <li id="n-sidebar-Docs"><a href="https://docs.joomla.org">Documentation</a></li> <li id="n-sidebar-Training"><a href="https://training.joomla.org">Training</a></li> <li id="n-sidebar-Certification"><a href="https://certification.joomla.org/">Certification</a></li> <li id="n-sidebar-Showcase"><a href="https://showcase.joomla.org/">Site Showcase</a></li> <li id="n-sidebar-Announcements"><a href="https://www.joomla.org/announcements.html">Announcements</a></li> <li id="n-sidebar-Blogs"><a href="https://community.joomla.org/blogs.html">Blogs</a></li> <li id="n-sidebar-Magazine"><a href="https://magazine.joomla.org/">Magazine</a></li> </ul> </li> <li class="has-dropdown active" id="p-sidebar-News"> <a href="#">Community & Support</a> <ul class="dropdown"> <li id="n-sidebar-Community"><a href="https://community.joomla.org/">Community Portal</a></li> <li id="n-sidebar-Events"><a href="https://events.joomla.org/">Events</a></li> <li id="n-sidebar-JUGs"><a href="https://community.joomla.org/user-groups.html">User Groups</a></li> <li id="n-sidebar-Forum"><a href="https://forum.joomla.org/">Forum</a></li> <li id="n-sidebar-Resources"><a href="https://resources.joomla.org/">Resources Directory</a></li> <li id="n-sidebar-Volunteers"><a href="https://volunteers.joomla.org/">Volunteers Portal</a></li> <li id="n-sidebar-Vel"><a href="https://vel.joomla.org">Vulnerable Extensions List</a></li> </ul> </li> <li class="has-dropdown active" id="p-sidebar-Developers"> <a href="#">Developer Resources</a> <ul class="dropdown"> <li id="n-sidebar-Developers"><a href="https://developer.joomla.org/">Developer Network</a></li> <li id="n-sidebar-Security"><a href="https://developer.joomla.org/security-centre.html">Security Centre</a></li> <li id="n-sidebar-Issues"><a href="https://issues.joomla.org/">Issue Tracker</a></li> <li id="n-sidebar-Github"><a href="https://github.com/joomla">GitHub</a></li> <li id="n-sidebar-API"><a href="https://api.joomla.org/">API Documentation</a></li> <li id="n-sidebar-Framework"><a href="https://framework.joomla.org/">Joomla! Framework</a></li> <li id="n-sidebar-JoomlaCode"><a href="http://joomlacode.org/">JoomlaCode</a></li> </ul> </li> </ul> <ul id="top-bar-right" class="right"> <li class="has-dropdown active"><a href="#"><i class="fa fa-cogs"></i></a> <ul id="toolbox-dropdown" class="dropdown"> <li id="t-whatlinkshere"><a href="/Special:WhatLinksHere/JDOC:How_to_Contribute_to_Joomla!_Documentation" title="A list of all wiki pages that link here [j]" accesskey="j">What links here</a></li><li id="t-recentchangeslinked"><a href="/Special:RecentChangesLinked/JDOC:How_to_Contribute_to_Joomla!_Documentation" rel="nofollow" title="Recent changes in pages linked from this page [k]" accesskey="k">Related changes</a></li><li id="t-specialpages"><a href="/Special:SpecialPages" title="A list of all special pages [q]" accesskey="q">Special pages</a></li><li id="t-print"><a href="javascript:print();" rel="alternate" title="Printable version of this page [p]" accesskey="p">Printable version</a></li><li id="t-permalink"><a href="/index.php?title=JDOC:How_to_Contribute_to_Joomla!_Documentation&oldid=1027660" title="Permanent link to this revision of the page">Permanent link</a></li><li id="t-info"><a href="/index.php?title=JDOC:How_to_Contribute_to_Joomla!_Documentation&action=info" title="More information about this page">Page information</a></li> <li id="n-recentchanges"><a href="/Special:RecentChanges" title="Special:RecentChanges">Recent changes</a></li> <li id="n-help" ><a href="/S:MyLanguage/Help:Contents">Help</a></li> </ul> </li> <li> <a href="/index.php?title=Special:UserLogin&returnto=JDOC%3AHow+to+Contribute+to+Joomla%21+Documentation">Log in</a> </li> </ul> </section> </nav> </div> <div id="global-header"> <nav class="global-header"> <div class="row"> <div class="large-6 column"> <h1 class="page-title"> <a href="/Main_Page"> <div class="title-name" style="display: inline-block;">Joomla! Documentation<sup>™</sup></div> </a> </h1> </div> <div class="large-6 column hide-for-small"> <ul class="button-group pull-right"> <li><a href="https://downloads.joomla.org/" class="button success radius" target="_blank">Download</a></li> <li><a href="https://launch.joomla.org/" class="button top radius" target="_blank">Launch</a></li> </ul> </div> </div> </nav> </div> <div id="bottom-nav"> <nav id="bottomnav" class="top-bar bottom row"> <ul class="title-area"> <li class="name"> <h1 class="title-name-small"> <a href="/Main_Page"> <div class="title-name" style="display:none;">Joomla! Documentation<sup>™</sup></div> </a> </h1> </li> <li class="toggle-topbar menu-icon"> <a href="#"><span></span></a> </li> </ul> <section class="top-bar-section"> <ul id="top-bar-left" class="left"> <li class="has-dropdown active" id='p-Learn'> <a href="#">Learn</a> <ul class="dropdown"> <li id="n-More-About-Joomla.21"><a href="/Special:MyLanguage/Portal:Learn_More">More About Joomla!</a></li><li id="n-Beginners"><a href="/Portal:Beginners">Beginners</a></li><li id="n-Administrators"><a href="/Portal:Administrators">Administrators</a></li><li id="n-Developers"><a href="/Portal:Developers">Developers</a></li><li id="n-Joomla.21-Get-Involved"><a href="/Portal:Participating_in_the_Community">Joomla! Get Involved</a></li><li id="n-Joomla.21-Code-Contributors"><a href="/Portal:Joomla!_Code_Contributors">Joomla! Code Contributors</a></li><li id="n-Joomla-User-Groups"><a href="/Special:MyLanguage/Portal:Joomla_User_Groups">Joomla User Groups</a></li> </ul> <li class="has-dropdown active" id='p-Browse'> <a href="#">Browse</a> <ul class="dropdown"> <li id="n-CMS-Help-Screens"><a href="/Help_screens">CMS Help Screens</a></li><li id="n-Our-Docs"><a href="/Category:Top_Level">Our Docs</a></li><li id="n-Our-Glossary"><a href="/Glossary">Our Glossary</a></li><li id="n-The-Joomla.21-FAQs"><a href="/Category:FAQ">The Joomla! FAQs</a></li><li id="n-Tips-and-tricks"><a href="/Category:Tips_and_tricks">Tips and tricks</a></li><li id="n-Recent-Changes"><a href="/Special:RecentChanges">Recent Changes</a></li> </ul> <li class="has-dropdown active" id='p-Help'> <a href="#">Help</a> <ul class="dropdown"> <li id="n-Contribute-to-Joomla.21-Docs"><a href="/JDOC:How_to_Contribute_to_Joomla!_Documentation">Contribute to Joomla! Docs</a></li><li id="n-Translate-Joomla.21-Docs"><a href="/JDOC:Documentation_Translators">Translate Joomla! Docs</a></li><li id="n-Editing-Help"><a href="/JHelp:Cheatsheet">Editing Help</a></li><li id="n-Play-in-the-Sandbox"><a href="/Sandbox">Play in the Sandbox</a></li><li id="n-JDOC.27s-Policies"><a href="/JDOC:Wiki_policy">JDOC's Policies</a></li><li id="n-Documentation-License"><a href="/JEDL">Documentation License</a></li><li id="n-More-Help"><a href="https://www.mediawiki.org/wiki/Special:MyLanguage/Help:Contents" rel="nofollow" target="_blank">More Help</a></li> </ul> </ul> <ul id="top-bar-right" class="right"> <li class="has-form"> <form action="/index.php" id="searchform" class="mw-search"> <div class="row"> <div class="small-12 columns"> <input type="search" name="search" placeholder="Search Joomla! Documentation" title="Search Joomla! Documentation [f]" accesskey="f" id="searchInput"/> <button type="submit" class="button search main">Search</button> </div> </div> </form> </li> </ul> </section> </nav> </div> </div> <div id="page-content"> <div class="row"> <div class="large-12 columns"> <!--[if lt IE 9]> <div id="siteNotice" class="sitenotice panel radius">Joomla! Documentation may not look as expected in this version of Internet Explorer. We recommend you upgrade to a newer version of Internet Explorer or switch to a browser like Firefox or Chrome.</div> <![endif]--> <!-- Output page indicators --> <div class="mw-indicators mw-body-content"> </div> <!-- If user is logged in output echo location --> </div> </div> <div id="mw-js-message" style="display:none;"></div> <div class="row"> <div id="p-cactions" class="large-12 columns"> <h4 class="namespace label">JDOC</h4> <article id="content"> <h1 class="title">How to Contribute to Joomla! Documentation</h1> <h3 id="tagline">From Joomla! Documentation</h3> <h5 class="subtitle"></h5> <div id="ad"> <script async="" type="text/javascript" src="//cdn.carbonads.com/carbon.js?zoneid=1673&serve=C6AILKT&placement=joomlaorg" id="_carbonads_js"></script> </div> <div class="clear_both"></div> <div class="mw-bodytext"> <div id="mw-content-text" lang="en" dir="ltr" class="mw-content-ltr"><div class="mw-parser-output"><div class="mw-parser-output"><div class="mw-pt-languages noprint" lang="en" dir="ltr"><div class="mw-pt-languages-label">Other languages:</div><div class="mw-pt-languages-list"><a href="/JDOC:How_to_Contribute_to_Joomla!_Documentation/id" class="mw-pt-progress mw-pt-progress--low" title="Bagaimana Berkontribusi ke Dokumentasi Joomla! (33% translated)" lang="id">Bahasa Indonesia</a> • <a href="/JDOC:How_to_Contribute_to_Joomla!_Documentation/de" class="mw-pt-progress mw-pt-progress--complete" title="Wie man die Joomla!-Dokumentation unterstützt (100% translated)" lang="de">Deutsch</a> • <span class="mw-pt-languages-ui mw-pt-languages-selected mw-pt-progress mw-pt-progress--complete" lang="en">English</span> • <a href="/JDOC:How_to_Contribute_to_Joomla!_Documentation/nl" class="mw-pt-progress mw-pt-progress--med" title="Hoe een bijdrage leveren aan Joomla! documentatie (53% translated)" lang="nl">Nederlands</a> • <a href="/JDOC:How_to_Contribute_to_Joomla!_Documentation/tr" class="mw-pt-progress mw-pt-progress--low" title="JDOC:Joomla! Belgelerine Nasıl Katkı Sağlanır (31% translated)" lang="tr">Türkçe</a> • <a href="/JDOC:How_to_Contribute_to_Joomla!_Documentation/et" class="mw-pt-progress mw-pt-progress--low" title="JDOC:Kuidas olla abiks Joomla! dokumentatsiooni saidil (24% translated)" lang="et">eesti</a> • <a href="/JDOC:How_to_Contribute_to_Joomla!_Documentation/es" class="mw-pt-progress mw-pt-progress--low" title="Cómo contribuir a la documentación de Joomla! (35% translated)" lang="es">español</a> • <a href="/JDOC:How_to_Contribute_to_Joomla!_Documentation/fr" class="mw-pt-progress mw-pt-progress--complete" title="Comment contribuer à la documentation Joomla! ? (100% translated)" lang="fr">français</a> • <a href="/JDOC:How_to_Contribute_to_Joomla!_Documentation/it" class="mw-pt-progress mw-pt-progress--low" title="Come contribuire a Joomla! Documentazione (22% translated)" lang="it">italiano</a> • <a href="/JDOC:How_to_Contribute_to_Joomla!_Documentation/pl" class="mw-pt-progress mw-pt-progress--stub" title="JDOC:How to Contribute to Joomla! Documentation/pl (2% translated)" lang="pl">polski</a> • <a href="/JDOC:How_to_Contribute_to_Joomla!_Documentation/pt" class="mw-pt-progress mw-pt-progress--med" title="Como Contribuir para Joomla - Documentação! (51% translated)" lang="pt">português</a> • <a href="/JDOC:How_to_Contribute_to_Joomla!_Documentation/pt-br" class="mw-pt-progress mw-pt-progress--complete" title="JDOC:Como contribuir para a documentação do Joomla! (96% translated)" lang="pt-BR">português do Brasil</a> • <a href="/JDOC:How_to_Contribute_to_Joomla!_Documentation/el" class="mw-pt-progress mw-pt-progress--low" title="JDOC: Πως να συνεισφέρετε στην Τεκμηρίωση του Joomla! (31% translated)" lang="el">Ελληνικά</a> • <a href="/JDOC:How_to_Contribute_to_Joomla!_Documentation/fa" class="mw-pt-progress mw-pt-progress--stub" title="چگونه در مستندات جوملا! مشارکت کنیم (8% translated)" lang="fa">فارسی</a> • <a href="/JDOC:How_to_Contribute_to_Joomla!_Documentation/hi" class="mw-pt-progress mw-pt-progress--stub" title="JDOC: Joomla! Documentation में योगदान कैसे करें (6% translated)" lang="hi">हिन्दी</a> • <a href="/JDOC:How_to_Contribute_to_Joomla!_Documentation/bn" class="mw-pt-progress mw-pt-progress--low" title="কিভাবে জুমলা! অবদান রাখবেন নথিপত্র (31% translated)" lang="bn">বাংলা</a> • <a href="/JDOC:How_to_Contribute_to_Joomla!_Documentation/zh-tw" class="mw-pt-progress mw-pt-progress--stub" title="JDOC:如何貢獻己力到 Joomla! 文件 (16% translated)" lang="zh-Hant-TW">中文(台灣)</a> • <a href="/JDOC:How_to_Contribute_to_Joomla!_Documentation/ja" class="mw-pt-progress mw-pt-progress--med" title="Joomla!ドキュメントに貢献する方法 (43% translated)" lang="ja">日本語</a></div></div> <p>Joomla! Documentation is powered by <a target="_blank" rel="nofollow noreferrer noopener" class="external text" href="https://www.mediawiki.org/wiki/MediaWiki">MediaWiki</a>. Its growth and success is dependent on <a href="/Special:ActiveUsers" title="Special:ActiveUsers">individuals like you</a>. Thank you for taking the first step towards contributing to the Joomla! Project. This page will show you how to get started and several ways of helping the documentation effort. </p> <div id="toc" class="toc" role="navigation" aria-labelledby="mw-toc-heading"><input type="checkbox" role="button" id="toctogglecheckbox" class="toctogglecheckbox" style="display:none" /><div class="toctitle" lang="en" dir="ltr"><h2 id="mw-toc-heading">Contents</h2><span class="toctogglespan"><label class="toctogglelabel" for="toctogglecheckbox"></label></span></div> <ul> <li class="toclevel-1 tocsection-1"><a href="#Getting_Started.21"><span class="tocnumber">1</span> <span class="toctext">Getting Started!</span></a> <ul> <li class="toclevel-2 tocsection-2"><a href="#Read_the_Wiki_Policy"><span class="tocnumber">1.1</span> <span class="toctext">Read the Wiki Policy</span></a></li> <li class="toclevel-2 tocsection-3"><a href="#Create_a_User_Account"><span class="tocnumber">1.2</span> <span class="toctext">Create a User Account</span></a></li> <li class="toclevel-2 tocsection-4"><a href="#Create_a_User_Page"><span class="tocnumber">1.3</span> <span class="toctext">Create a User Page</span></a></li> <li class="toclevel-2 tocsection-5"><a href="#Join_the_Documentation_Communication_Channels"><span class="tocnumber">1.4</span> <span class="toctext">Join the Documentation Communication Channels</span></a></li> </ul> </li> <li class="toclevel-1 tocsection-6"><a href="#What_Should_I_Do_First.3F"><span class="tocnumber">2</span> <span class="toctext">What Should I Do First?</span></a> <ul> <li class="toclevel-2 tocsection-7"><a href="#Help_Manage_Our_Content"><span class="tocnumber">2.1</span> <span class="toctext">Help Manage Our Content</span></a></li> <li class="toclevel-2 tocsection-8"><a href="#Wiki_Maintenance"><span class="tocnumber">2.2</span> <span class="toctext">Wiki Maintenance</span></a></li> <li class="toclevel-2 tocsection-9"><a href="#Documentation_Projects"><span class="tocnumber">2.3</span> <span class="toctext">Documentation Projects</span></a></li> <li class="toclevel-2 tocsection-10"><a href="#Help_Screens"><span class="tocnumber">2.4</span> <span class="toctext">Help Screens</span></a></li> </ul> </li> <li class="toclevel-1 tocsection-11"><a href="#Things_to_Remember"><span class="tocnumber">3</span> <span class="toctext">Things to Remember</span></a></li> <li class="toclevel-1 tocsection-12"><a href="#Help.2C_I_Don.27t_Know_Wiki_Markup.21"><span class="tocnumber">4</span> <span class="toctext">Help, I Don't Know Wiki Markup!</span></a></li> </ul> </div> <h2><span id="Getting_Started!"></span><span class="mw-headline" id="Getting_Started.21">Getting Started!</span><span class="mw-editsection"><span class="mw-editsection-bracket">[</span><a href="/index.php?title=JDOC:How_to_Contribute_to_Joomla!_Documentation&action=edit&section=1" title="Edit section: Getting Started!">edit</a><span class="mw-editsection-bracket">]</span></span></h2> <p>There are a few things you will need to do first. </p> <h4><span class="mw-headline" id="Read_the_Wiki_Policy">Read the Wiki Policy</span><span class="mw-editsection"><span class="mw-editsection-bracket">[</span><a href="/index.php?title=JDOC:How_to_Contribute_to_Joomla!_Documentation&action=edit&section=2" title="Edit section: Read the Wiki Policy">edit</a><span class="mw-editsection-bracket">]</span></span></h4> <p>You need to review the Joomla! Docs <b><a href="/Special:MyLanguage/JDOC:Wiki_policy" title="Special:MyLanguage/JDOC:Wiki policy">Wiki policy</a></b> before you start editing. </p> <h4><span class="mw-headline" id="Create_a_User_Account">Create a User Account</span><span class="mw-editsection"><span class="mw-editsection-bracket">[</span><a href="/index.php?title=JDOC:How_to_Contribute_to_Joomla!_Documentation&action=edit&section=3" title="Edit section: Create a User Account">edit</a><span class="mw-editsection-bracket">]</span></span></h4> <p>To edit the Joomla! Documentation Wiki, you will need a user account. You may <b><a href="/Special:CreateAccount" title="Special:CreateAccount">register for one here</a></b>. Afterwards make sure to confirm your email address. Confirmation of your e-mail address will give you permission to edit any page except for a few that are protected. </p><p><i>Note: If you do not do any edit within 5 days following the creation of your account, your account will be automatically deleted for security reasons.</i> </p> <h4><span class="mw-headline" id="Create_a_User_Page">Create a User Page</span><span class="mw-editsection"><span class="mw-editsection-bracket">[</span><a href="/index.php?title=JDOC:How_to_Contribute_to_Joomla!_Documentation&action=edit&section=4" title="Edit section: Create a User Page">edit</a><span class="mw-editsection-bracket">]</span></span></h4> <p>After you have created an account, confirmed your email address and logged in, we recommend you take a few moments to create a User page. Creating a user page serves a few purposes: </p> <ul><li>It lets users find out more about you.</li> <li>It lets you make some initial edits so that the <a href="/User:Abuse_filter" title="User:Abuse filter">Wiki spammer and abuse filter</a> can see that you're not a fake user. Note that for your first few edits, don't include external links as that will be what is most likely to trigger the filters.</li></ul> <p>A quick cheat to start your user page: </p> <ul><li>On the user menu, go to your <b>Username</b> page (or use first menu item on far right dropdown)</li> <li>Click the actions drop down button<div style="clear:both;"></div><a href="/File:JDOCS-actions-create-page-en.png" class="image"><img alt="JDOCS-actions-create-page-en.png" src="/images/a/a3/JDOCS-actions-create-page-en.png" decoding="async" width="215" height="174" data-file-width="215" data-file-height="174" /></a></li> <li>Click Create</li> <li>Add the code to editor <code>{{subst:Newuser}}</code></li> <li>Fill in summary (e.g. <i>This is my new user page</i>)<div style="clear:both;"></div><a href="/File:JDOCS-summary-form-input-en.png" class="image"><img alt="JDOCS-summary-form-input-en.png" src="/images/7/7a/JDOCS-summary-form-input-en.png" decoding="async" width="500" height="92" data-file-width="500" data-file-height="92" /></a></li> <li>Click the Save button</li></ul> <h4><span class="mw-headline" id="Join_the_Documentation_Communication_Channels">Join the Documentation Communication Channels</span><span class="mw-editsection"><span class="mw-editsection-bracket">[</span><a href="/index.php?title=JDOC:How_to_Contribute_to_Joomla!_Documentation&action=edit&section=5" title="Edit section: Join the Documentation Communication Channels">edit</a><span class="mw-editsection-bracket">]</span></span></h4> <p>Joomla's official communication tool is <a target="_blank" rel="nofollow noreferrer noopener" class="external text" href="https://joomlacommunity.cloud.mattermost.com/">Mattermost</a>. <a href="/Mattermost" title="Mattermost">See this page</a> for information on how to join the conversation and once you're in there, join the <a target="_blank" rel="nofollow noreferrer noopener" class="external text" href="https://joomlacommunity.cloud.mattermost.com/main/channels/pd-documentation">PD Documentation</a> channel to join the discussion on Joomla! Documentation. </p> <h2><span id="What_Should_I_Do_First?"></span><span class="mw-headline" id="What_Should_I_Do_First.3F">What Should I Do First?</span><span class="mw-editsection"><span class="mw-editsection-bracket">[</span><a href="/index.php?title=JDOC:How_to_Contribute_to_Joomla!_Documentation&action=edit&section=6" title="Edit section: What Should I Do First?">edit</a><span class="mw-editsection-bracket">]</span></span></h2> <p>There are several areas of documentation which always need attention. You can start by picking the one which is the most comfortable for you to work on or you may get more involved by working on several at a time. Once you have a Wiki account, you are free to work on any aspect of the documentation that takes your fancy. Even the simplest contributions such as spelling corrections and grammar fixes are a tremendous help! </p> <ol><li><a href="#Help_Manage_Our_Content">Help with documentation content</a>.</li> <li><a href="#Wiki_Maintenance">Maintenance Tasks</a>.</li> <li><a href="#Documentation_Project">Join or start documentation project</a>.</li> <li><a href="#Help_Screens">Help with Help Screens</a>.</li> <li><a href="/JDOC:Page_Translation_Explained" title="JDOC:Page Translation Explained">Page Translation Explained</a></li></ol> <h3><span class="mw-headline" id="Help_Manage_Our_Content">Help Manage Our Content</span><span class="mw-editsection"><span class="mw-editsection-bracket">[</span><a href="/index.php?title=JDOC:How_to_Contribute_to_Joomla!_Documentation&action=edit&section=7" title="Edit section: Help Manage Our Content">edit</a><span class="mw-editsection-bracket">]</span></span></h3> <ol><li>Editing, rewriting and reorganising pages. Check our <a href="/Special:MyLanguage/Category:Joomla!_Wiki_need_pages" title="Special:MyLanguage/Category:Joomla! Wiki need pages">Needs pages</a> for areas needing immediate help. They are called <i>Needs pages</i> because they are in need of small tasks to complete them. Some of them are as simple as reviewing content or adding an image. Others require more content or improvements. Pick a few, give them a little love. This is a tremendous help to Joomla! users who rely on our documentation.</li> <li>Have some fun and browse for articles which are redundant, out of version (i.e. 1.0 and 1.5), or need to be split up because of version specific information. Then feel free to make use of the {{<a href="/Template:Delete" title="Template:Delete">delete</a>}}, {{<a href="/Template:Merge" title="Template:Merge">merge</a>}} or {{<a href="/Template:JSplit" title="Template:JSplit">JSplit</a>}} templates on the articles. <i>Click the previous template links to see how to use and apply them to articles you think need these marker templates. Add them to the very top of a page and the page is marked.</i></li> <li><b>Create a new page or tutorial.</b> If you want to start a new page, do some extensive research first. Don't to create a new article if one already exists. Use the <a href="/Special:Search" title="Special:Search">search feature</a> of the Docs Wiki to see if your topic is already in an article. <b>Duplication will be merged and/or deleted</b>. Don't be afraid to modify, reformat or improve someone else's work on the Joomla! Docs Wiki! This is a collaborative documentation Wiki. Just make sure you are following our <a href="/Special:MyLanguage/JDOC:Policies_and_guidelines" title="Special:MyLanguage/JDOC:Policies and guidelines">policy and guidelines</a>. <ol><li><i>Using Wikilinks.</i> It's very easy to link pages using a standard syntax. If you create a link to an article that doesn't exist yet, the link will be colored red. Clicking a red link will take you to the edit page for the new article. Simply type your text, click save and the new page will be created. Once the page has been created, the link will change from red to blue indicating that the article now exists.</li> <li><i>Using the URL.</i> To use when you want to create a page from scratch. You can use the Wiki's URL for creating a new page. The URL to an article of the Wiki is usually something like this: <tt>https://docs.joomla.org/YOURTITLE</tt>. If you replace YOURTITLE with the name of the page you wish to create, you will be taken to a blank page which indicates that no article of that name exists yet. Clicking the <i>Create this page</i> link will take you to the edit page for that article, where you can create the new page by typing your text, and clicking <i>Submit</i>.</li></ol></li> <li><b>Help update images in articles.</b> Check the category <a href="/Special:MyLanguage/:Category:Needs_image_updating" title="Special:MyLanguage/:Category:Needs image updating">Needs image updating</a> for a list of pages which need their images updated. Our suggested guidelines to help you are found in the article, <a href="/Special:MyLanguage/JDOC:Image_naming_guidelines" title="Special:MyLanguage/JDOC:Image naming guidelines">Image naming guidelines</a>.</li></ol> <h3><span class="mw-headline" id="Wiki_Maintenance">Wiki Maintenance</span><span class="mw-editsection"><span class="mw-editsection-bracket">[</span><a href="/index.php?title=JDOC:How_to_Contribute_to_Joomla!_Documentation&action=edit&section=8" title="Edit section: Wiki Maintenance">edit</a><span class="mw-editsection-bracket">]</span></span></h3> <dl><dd>Maintaining a Wiki and keeping it organised takes a lot of continuous work on the part of administrators, editors and users. There are always tasks needing attention such as: <a href="/Special:UncategorizedPages" title="Special:UncategorizedPages">Categorisation</a>, <a href="/Special:MyLanguage/Category:Joomla!_Wiki_need_pages" title="Special:MyLanguage/Category:Joomla! Wiki need pages">attending to pages with needs</a>, that are <a href="/Special:MyLanguage/Category:Article_under_construction" title="Special:MyLanguage/Category:Article under construction">under construction</a>, or by marking pages for <a href="/Template:Delete" title="Template:Delete">deletion</a>, <a href="/Template:Merge" title="Template:Merge">merging</a> or <a href="/Template:JSplit" title="Template:JSplit">splitting</a>. For all maintenance tasks and ideas of how you can help, please visit our <a href="/Special:MyLanguage/JDOC:Maintenance_Tasks" title="Special:MyLanguage/JDOC:Maintenance Tasks">Documentation Maintenance page</a>.</dd></dl> <h3><span class="mw-headline" id="Documentation_Projects">Documentation Projects</span><span class="mw-editsection"><span class="mw-editsection-bracket">[</span><a href="/index.php?title=JDOC:How_to_Contribute_to_Joomla!_Documentation&action=edit&section=9" title="Edit section: Documentation Projects">edit</a><span class="mw-editsection-bracket">]</span></span></h3> <ul><li>The Docs team is working on <a href="/Special:MyLanguage/Tutorials:Beginners" title="Special:MyLanguage/Tutorials:Beginners">Beginner Tutorials</a>. Our goal is to make them easy to understand and navigate, something a Beginner can follow easily and learn basic concepts. Think back to when you were new to Joomla! and add a topic about something you struggled with as a beginner to the page. Better yet, join the <a href="/Special:MyLanguage/JDOC:Beginners_Tutorial_Project" title="Special:MyLanguage/JDOC:Beginners Tutorial Project">Beginner Tutorials Project</a>.</li> <li>Join the <a href="/Special:MyLanguage/JDOC:Developer_Tutorials_Project" title="Special:MyLanguage/JDOC:Developer Tutorials Project">Developer Tutorials Project</a> and share your knowledge. Sign your name using 4 tildes ( ~~~~ ) on the <a href="/Special:MyLanguage/JDOC_talk:Developer_Tutorials_Project" title="Special:MyLanguage/JDOC talk:Developer Tutorials Project">Developer Tutorials Project</a> page and list what you might be able to do. Feel free to add some <a href="/Special:MyLanguage/JDOC:Developer_Tutorials_Project/Topics" title="Special:MyLanguage/JDOC:Developer Tutorials Project/Topics">tutorial topics</a> to the suggested topics list.</li></ul> <h3><span class="mw-headline" id="Help_Screens">Help Screens</span><span class="mw-editsection"><span class="mw-editsection-bracket">[</span><a href="/index.php?title=JDOC:How_to_Contribute_to_Joomla!_Documentation&action=edit&section=10" title="Edit section: Help Screens">edit</a><span class="mw-editsection-bracket">]</span></span></h3> <p>Unknown to many, all <a href="/Special:MyLanguage/Help_screens" title="Special:MyLanguage/Help screens">Help Screen</a> pages are created and served to every Joomla! installation worldwide from this Wiki! They are necessary for beginners and even those with intermediate knowledge of Joomla! </p><p><b>The Joomla! 4.x Help Screens need to be reviewed and updated</b>. Any contribution you give to them will be appreciated by many users worldwide and we're looking for volunteers to help with this important task. A matrix needs to be put in place as well as an action plan. </p> <h2><span class="mw-headline" id="Things_to_Remember">Things to Remember</span><span class="mw-editsection"><span class="mw-editsection-bracket">[</span><a href="/index.php?title=JDOC:How_to_Contribute_to_Joomla!_Documentation&action=edit&section=11" title="Edit section: Things to Remember">edit</a><span class="mw-editsection-bracket">]</span></span></h2> <p>Here are a few things to remember as a Joomla! Docs contributor. </p> <ul><li>Don't be afraid to break a page, if you do and something has gone really wrong, revert your edit. Click the page's <b>History</b> tab and you will see links to undo and revert.</li> <li>Write articles with a sense they will be translated to another language. Using slang or local dialect may not translate to another language or its inferences be understood. Find out more about <a href="/JDOC:Documentation_Translators" title="JDOC:Documentation Translators">Translating Joomla Documentation</a>.</li> <li>Don't be afraid to download and read the general <a target="_blank" rel="noreferrer noopener" class="external text" href="https://developer.joomla.org/en-gb-user-interface-text-guidelines/introduction.html">Joomla! en-GB User Interface Text Guidelines</a> that applies to all Joomla! Documentation. There are helpful hints on how to write for Joomla! Documentation.</li> <li>Words to watch when writing for instant feedback use Google Chrome or Mozilla Firefox browsers. They both have built-in spell checking which underlines a misspelled word.</li> <li>Don't forget to add the {{<a href="/Template:Inuse" title="Template:Inuse">inuse</a>}} template to an article you are going to be working on it for a long period of time, more than a minute. It helps to prevent editing conflicts.</li></ul> <h2><span id="Help,_I_Don't_Know_Wiki_Markup!"></span><span class="mw-headline" id="Help.2C_I_Don.27t_Know_Wiki_Markup.21">Help, I Don't Know Wiki Markup!</span><span class="mw-editsection"><span class="mw-editsection-bracket">[</span><a href="/index.php?title=JDOC:How_to_Contribute_to_Joomla!_Documentation&action=edit&section=12" title="Edit section: Help, I Don't Know Wiki Markup!">edit</a><span class="mw-editsection-bracket">]</span></span></h2> <p>If you are new to the use of Wikis and the simple markup to create pages, then use the following for help. </p> <ul><li>New WikiEditor contains buttons and quick links to make building pages easier. Click the word <i>Advanced</i> for a drop down of more buttons and quick formatting links.</li> <li>Use the <a href="/Special:MyLanguage/Help:Cheatsheet" title="Special:MyLanguage/Help:Cheatsheet">JDOC's Wiki Cheatsheet</a> to learn the basic syntax commands. There is also a drop down of the common markup in the editor. Just click the word <i>Help</i> once and it will appear.</li> <li>Still afraid? Try these tools to help you create great Wiki pages.</li></ul> <dl><dd><ul><li><a target="_blank" rel="nofollow noreferrer noopener" class="external text" href="https://www.microsoft.com/en-us/download/details.aspx?id=12298">Microsoft Word Add-on for Wiki Markup</a>, save Word Docs in Wiki Markup.</li> <li><b>OpenOffice.org versions 2.4 and later</b> have a MediaWiki export filter built in. Just open a Writer document and click File - Export. Then, change File format to MediaWiki.</li> <li>Here is a <a href="https://en.wikipedia.org/wiki/Wikipedia:Tools#Importing_.28converting.29_content_to_Wikipedia_.28MediaWiki.29_format" class="extiw" title="wp:Wikipedia:Tools">list of tools</a> available to convert other formats to Wiki markup, e.g. HTML, Excel, CSV. Some of them are online converters, cut and paste HTML for an output in Wiki markup.</li></ul></dd></dl> <ul><li>Get help on <a target="_blank" rel="nofollow noreferrer noopener" class="external text" href="https://joomlacommunity.cloud.mattermost.com/">Mattermost</a> (We have a lot of channels there. E.g. one for the JDocs Translation Group and one for the JDocs Working group).</li> <li>Post a question on an <a target="_blank" rel="noreferrer noopener" class="external text" href="https://docs.joomla.org/index.php?title=Special%3AListUsers&username=&group=sysop&limit=50">administrator's</a> or <a target="_blank" rel="noreferrer noopener" class="external text" href="https://docs.joomla.org/index.php?title=Special%3AListUsers&username=&group=editor&limit=50">editor's</a> talk page.</li></ul> <!-- NewPP limit report Cached time: 20241117223851 Cache expiry: 86400 Dynamic content: false Complications: [] CPU time usage: 0.131 seconds Real time usage: 0.160 seconds Preprocessor visited node count: 189/1000000 Post‐expand include size: 178/2097152 bytes Template argument size: 44/2097152 bytes Highest expansion depth: 4/40 Expensive parser function count: 0/100 Unstrip recursion depth: 0/20 Unstrip post‐expand size: 4125/5000000 bytes --> <!-- Transclusion expansion time report (%,ms,calls,template) 100.00% 10.196 1 -total 72.18% 7.359 4 Template:Tl 22.53% 2.297 2 Template:- --> <!-- Saved in parser cache with key docsj_mediawiki:pcache:idhash:29261-0!canonical and timestamp 20241117223850 and revision id 1027660 --> </div></div></div><div class="printfooter"> Retrieved from "<a dir="ltr" href="https://docs.joomla.org/index.php?title=JDOC:How_to_Contribute_to_Joomla!_Documentation&oldid=1027660">https://docs.joomla.org/index.php?title=JDOC:How_to_Contribute_to_Joomla!_Documentation&oldid=1027660</a>"</div> <div class="clear_both"></div> </div> <div class="group"><div id="catlinks" class="catlinks" data-mw="interface"><div id="mw-normal-catlinks" class="mw-normal-catlinks"><a href="/Special:Categories" title="Special:Categories">Categories</a>: <ul><li><a href="/Category:Documentation_Wiki_Information" title="Category:Documentation Wiki Information">Documentation Wiki Information</a></li><li><a href="/Category:Volunteer_Engagement" title="Category:Volunteer Engagement">Volunteer Engagement</a></li></ul></div></div></div> </article> </div> </div> <footer class="row"> <div id="footer"> <div id="footer-left" class="large-8 small-12 columns"> <ul id="footer-left"> <li id="footer-lastmod"> This page was last edited on 30 May 2024, at 21:03.</li> <li id="footer-copyright">Content is available under <a href="/JEDL" title="JEDL">Joomla! EDL</a> unless otherwise noted.<br>Joomla!<sup>®</sup> is a registered trademark of Open Source Matters, Inc.<br>If you are experiencing technical issues with this website, <html><a href="https://github.com/joomla/joomla-websites/issues/new?title=%5Bjdocs%5D%20&body=Please%20describe%20the%20problem%20or%20your%20issue" target="_blank" rel="nofollow">please report it</a><!-- Cached 20241118212416 --> </html>. <br>Notice a content problem? <html><a href="/JDOC:How_to_Contribute_to_Joomla!_Documentation" rel="nofollow">Create an account</a><!-- Cached 20241118212416 --> </html> and fix it.</li> <li id="footer-privacy"><a href="/JDOC:Privacy_policy" title="JDOC:Privacy policy">Privacy policy</a></li> <li id="footer-about"><a href="/JDOC:About" title="JDOC:About">About Joomla! Documentation</a></li> <li id="footer-disclaimer"><a href="/JDOC:General_disclaimer" class="mw-redirect" title="JDOC:General disclaimer">Terms of Service</a></li> </ul> </div> <div id="footer-right-icons" class="large-4 small-12 columns"> <ul id="poweredby"> <li class="copyright"> <a href="https://docs.joomla.org/JEDL" target="_blank"><img src="https://docs.joomla.org/skins/JEDL_icon.png" alt="Joomla! EDL" width="88" height="31" loading="lazy"/></a> </li> <li class="poweredby"> <a href="https://www.mediawiki.org/" target="_blank"><img src="/resources/assets/poweredby_mediawiki_88x31.png" alt="Powered by MediaWiki" srcset="/resources/assets/poweredby_mediawiki_132x47.png 1.5x, /resources/assets/poweredby_mediawiki_176x62.png 2x" width="88" height="31" loading="lazy"/></a> </li> <li class="rochen"> <a href="https://www.rochen.com/joomla-hosting" target="_blank"><img src="//cdn.joomla.org/rochen/rochen_footer_logo_white.png" alt="Joomla! Hosting by Rochen..." width="88" height="31" loading="lazy"/></a> </li> </ul> </div> </div> </footer> </div> <script>(RLQ=window.RLQ||[]).push(function(){mw.config.set({"wgPageParseReport":{"limitreport":{"cputime":"0.131","walltime":"0.160","ppvisitednodes":{"value":189,"limit":1000000},"postexpandincludesize":{"value":178,"limit":2097152},"templateargumentsize":{"value":44,"limit":2097152},"expansiondepth":{"value":4,"limit":40},"expensivefunctioncount":{"value":0,"limit":100},"unstrip-depth":{"value":0,"limit":20},"unstrip-size":{"value":4125,"limit":5000000},"timingprofile":["100.00% 10.196 1 -total"," 72.18% 7.359 4 Template:Tl"," 22.53% 2.297 2 Template:-"]},"cachereport":{"timestamp":"20241117223851","ttl":86400,"transientcontent":false}}});mw.config.set({"wgBackendResponseTime":195});});</script> </body> <!-- Cached 20241118212416 --> </html>