JDOC

Difference between revisions of "Joomla! Doc Sprints/Start Here"

From Joomla! Documentation

< JDOC:Joomla! Doc Sprints
m (→‎Documentation Help by Audiences: update to uninclude 2.5)
(33 intermediate revisions by the same user not shown)
Line 1: Line 1:
−
<div class=row">
+
<div class="NavFrame small-12 large-4-spaced columns panel right" style="vertical-align:top; border:1px solid #abd5f5; background-color:#f1f5fc; font-size:85%;padding:.5em; margin-left:.5em">
−
<div class="small-12 large-6-spaced columns panel" style="vertical-align:top; border:1px solid Gold; background-color: LightYellow; font-size:85%;padding:.5em">
+
<div class="NavHead" style="border-bottom:1px solid #abd5f5; background-color:#d0e5f5; padding:0.2em 0.5em 0.2em 0.5em; font-size:110%;">'''Reference Information'''</div>
−
<div style="border-bottom:1px solid Gold; background-color:#ffffaa; padding:0.2em 0.5em 0.2em 0.5em; font-size:110%; font-weight:bold;">Instructions</div>
+
<div class="NavContent" style="display: none;">
−
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 <nowiki>"[[text]]"</nowiki>.  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://irc.freenode.net/joomladocs IRC channel].
 
−
 
 
−
'''When you begin editing a page please add <nowiki>{{inuse}}</nowiki> 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.'''
 
−
</div>
 
−
<div class="small-12 large-6-spaced columns panel" style="vertical-align:top; border:1px solid #abd5f5; background-color:#f1f5fc; font-size:85%;padding:.5em">
 
−
<div style="border-bottom:1px solid #abd5f5; background-color:#d0e5f5; padding:0.2em 0.5em 0.2em 0.5em; font-size:110%; font-weight:bold;">Reference Information</div>
 
 
* If you are new to MediaWiki then you should consult the '''[http://meta.wikimedia.org/wiki/Help:Contents User's Guide]''' for information on using the wiki software.
 
* If you are new to MediaWiki then you should consult the '''[http://meta.wikimedia.org/wiki/Help:Contents User's Guide]''' for information on using the wiki software.
 
* List of '''[[JDOC:Local wiki templates|local wiki templates]]''' that can be used in your wiki pages.  Templates reduce repetition and are the basis of modular documentation.
 
* List of '''[[JDOC:Local wiki templates|local wiki templates]]''' that can be used in your wiki pages.  Templates reduce repetition and are the basis of modular documentation.
Line 16: Line 8:
 
* Please read the '''[http://help.joomla.org/workshop/documents/Editorial%20Style%20Guide%20v1.0.5.pdf Joomla! Editorial Style Guide]''' and the list of '''[[Project:W2W|words to watch]]'''.
 
* Please read the '''[http://help.joomla.org/workshop/documents/Editorial%20Style%20Guide%20v1.0.5.pdf Joomla! Editorial Style Guide]''' and the list of '''[[Project:W2W|words to watch]]'''.
 
</div>
 
</div>
−
</div>{{-}}
+
</div>
 +
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.
  
−
== Where to start ==
+
Remember, if you want to help with translation of our documentation you should go to the page specifically for [[JDOC:Documentation_Translators|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.
−
Looking for a topic to write about?  For small tasks look in the Cookie Jar (below).
 
  
−
There are lists about:
+
{{tip|title=Please Remember|When you begin editing a page please add '''<nowiki>{{inuse}}</nowiki>''' to the top of the page before you start working on it so that others do not create conflicting changes to the same page.  Then don't forget to remove it again when you have finished!  Thank you.}}
−
* requested but yet [[Special:Wantedpages|empty pages]]
+
{{-}}
−
* [[:Category:Needs_review|Articles that require a review]] awaiting a copy editor
+
== Where to start? Confused? [[File:Confused.png|32px]]  ==
 +
Looking for a topic to write about? Please consider helping [[JDOC:Joomla!_Doc_Sprints/Start_Here#Under_Construction|complete an article under construction]] listed here first before creating any new articles. We are trying to organise our content, find holes, note and fix them, or document future features being released.
 +
 
 +
For small tasks look in the Quick Tasks (below). These will mainly be editing for misspelling, grammar, and flow. 5 minute reads, and they can be cleared out. There are category lists about many topics of need on docs, here are a few:
 +
* [[:Category:Needs_review|Articles that require a review]] are awaiting a second opinion or a review for accuracy.
 +
* [[:Category:Needs_improvement|Article in need of improvement]] require more information to make them useful.
 +
* [[:Category:Needs_completion|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.
 
Otherwise, look down this page and browse the links.
  
−
==Doc Camp Cookie Jar==
+
== Quick Tasks (Reviews and Images) ==
−
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.
+
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 because they are high traffic pages. Please remove them once they have been edited.
 +
 
 
* [[Register globals]]
 
* [[Register globals]]
 
* [[Using an FTP client to upload files]]
 
* [[Using an FTP client to upload files]]
−
* [[Using a terminal session]]
 
  
−
==Audience: Users/Administrators==
+
This is a list of pages added auto-magically in need of copyediting in general so they can be moved to translation status.
 +
 
 +
<small>List of all articles belonging to the "Needs copyediting" category. They really just need another editor to review them quickly or upload appropriate images.</small>
 +
<DPL>
 +
noresultsheader=No articles found\n 
 +
category=Need copyediting
 +
include={version}:1 
 +
format  = ,\n* [[%PAGE%|%TITLE%]]&nbsp;²{JVer/multi¦,}²,
 +
</DPL>
 +
 
 +
== New Joomla Features ==
 +
 
 +
This list if for features just released or being released in the near future. Please add to the list by editing the section with an appropriate, descriptive title using the '''<code>J#.x:</code>''' prefix (only if it is version specific), e.g. <code><nowiki>[[J3.x:A Descriptive Title]]</nowiki></code>. Then add a short summary of what it should contain.
 +
 
 +
=== J3.4 Release ===
 +
* [[J3.x:Installing Weblinks]] - How to install it if you want to use it with your website.
 +
* [[J3.x:Using Composer with Joomla]] - What it is, how to use it for devs, and it's purpose.
 +
 
 +
==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.
 
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.
  
Line 39: Line 58:
 
<DPL>
 
<DPL>
 
noresultsheader=No articles found\n   
 
noresultsheader=No articles found\n   
 +
notnamespace=J2.5
 
category=Needs review
 
category=Needs review
 
categorymatch=%Management%
 
categorymatch=%Management%
 
include={version}:1   
 
include={version}:1   
 
format  = ,\n* [[%PAGE%|%TITLE%]]&nbsp;²{JVer/multi¦,}²,
 
format  = ,\n* [[%PAGE%|%TITLE%]]&nbsp;²{JVer/multi¦,}²,
−
</DPL><noinclude>
+
</DPL>
  
−
==Audience: Web Designers==
+
===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.
 
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.
  
−
* [[Accessibility]]
+
<small>List of all articles belonging to the categories "Need review" AND "Template specific article"</small>
−
* [[Beez]] - an accessible default template
+
<DPL>
−
* [[Creating clickable background images using CSS]].
+
noresultsheader=No articles found\n 
−
* There is quite a lot for web designers in the [[Joomla! 1.5 Template Tutorials Project]]. In particular, look at the [[Outline for Template Tutorials]].
+
notnamespace=J2.5
−
* [[jdoc statements]] for templates
+
category=Needs%
−
* Modify the [[favicon]]
+
categorymatch=%Templat%|%templat%
 +
notnamespace=JDOC
 +
include={version}:1   
 +
format  = ,\n* [[%PAGE%|%TITLE%]]&nbsp;²{JVer/multi¦,}²,
 +
</DPL>
  
−
==Audience: Core Developers==
+
===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.
 
By "core developers" we mean developers who are contributing to the Joomla! core distribution which includes the core extensions as well as the Framework.
  
−
* Developer guidelines.
+
<small>List of all articles belonging to the categories "Need review" AND "Core or Bug Squad"</small>
−
* [[Participating in the community]]: a brief description of how people can get involved.
+
<DPL>
−
* Coding style and standards.
+
noresultsheader=No articles found\n 
−
* Secure coding guidelines.
+
notnamespace=J2.5
−
* Error message conventions.
+
category=Needs%
−
* Exception handling.
+
categorymatch=%Core%|%Bug%
−
* [[Patch submission guidelines]].
+
include={version}:1 
−
* [[Filing bugs and issues]].
+
format  = ,\n* [[%PAGE%|%TITLE%]]&nbsp;²{JVer/multi¦,}²,
−
* [[How to release a distribution tarball]].
+
</DPL>
−
* Release numbering, compatibility and deprecation.
 
−
* [[Localisation]] (L18N): an explanation of how localisation is implemented in Joomla! 1.5 and how to use it.
 
−
* [[Routing]]: how it works and how to use it
 
  
−
==Audience: Third-party Developers==
+
===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.
 
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.
  
−
* Complete/update/review the wiki API reference (assumes this has been moved from DocuWiki to MediaWiki).
+
<small>List of all articles belonging to the categories "Need review" AND "Extension developers"</small>
−
* Update developer tutorials and how-to's currently on dev.joomla.org
+
<DPL>
−
** Review all material under the tutorials heading at http://dev.joomla.org/component/option,com_jd-wiki/Itemid,32/
+
noresultsheader=\nNo articles found   
−
** Recommend material to be migrated over to docs.joomla.org
+
notnamespace=J2.5
−
** Update material that is to be migrated over to docs.joomla.org
+
category=Needs%
−
* [[How to debug your code]].
+
categorymatch=%Extension%
−
** Write a tutorial giving debugging tips for new developers.  Perhaps list different kinds of problems code might have and suggested approaches to locating the problem and fixing it.
+
include={version}:1 
−
* [[Using the core parameter types]] (To be reviewed)
+
format  = ,\n* [[%PAGE%|%TITLE%]]&nbsp;²{JVer/multi¦,}²,
−
* [[Creating custom XML parameter types]].
+
</DPL>
−
** Write a document detailing the steps to creating a custom XML Parameter type.  Explain how these types can be used in templates, modules, components and plugins.
 
−
* [[Creating component preferences]] (ready for review).
 
−
** Write a document describing how to create an xml file for modifying component preferences and how to add a Parameters button to an administrator toolbar.
 
−
* [[Adding JavaScript and CSS to the page]].
 
−
** Write a document describing how to add JavaScript and CSS to the page.  Explain how to decide whether JavaScript should go in the head block or in the page itself and how to insert the JavaScript.
 
−
* [[Accessing the current user object]].
 
−
** Write a document describing how to access the current user object and also indicate what type of information can be found in the object, and how that data should be retrieved and/or set.
 
−
* [[Adding AJAX to your component]].
 
−
** Write a document describing how to add AJAX to an MVC component.  If desired, use the MVC Hello World tutorial as a base.  Describe where various elements should go in the MVC design pattern. Also describe how to implement MVC in a module (these need supporting components to do AJAX).
 
−
* [[Using JPagination in your component]] (frontend and backend).
 
−
** Describe the steps necessary to add pagination to a component using the JPagination class.  Describe the differences between frontend and backend.
 
−
* [[Creating a toolbar for your component]].
 
−
* [[Adding configuration objects to modules and plugins]].
 
−
* [[Storing data in the session between page loads]].
 
−
* [[Using the caching system in your component]].
 
−
* [[Creating a file uploader in your component]].
 
−
* [[Suppressing output of extra HTML]].
 
−
* [[Supporting plugins in your component]] (Ready for review).
 
−
** Explain how to add triggers so that your component can fire custom events.
 
−
* [[Adding multi-language support]].
 
−
* [[Retrieving data from GET and POST requests]] - the Joomla! way.
 
−
* [[Adding view layout configuration parameters]].
 
−
** Explain how to create an XML file that will allow users to configure views.
 
−
* [[Using the installer API to support package installation]].
 
−
** Explain how to use the JInstaller API to install add-ons to components
 
−
* [[How to implement XML-RPC in a component]]
 
−
** There are two ways to do this:
 
−
*** Implement it using an XML-RPC plugin
 
−
*** Implement it in the component itself using raw views
 
−
* [[How to use the filesystem package]]
 
−
* [[How to use the filter package]]
 
−
** Describe how and when to use the Filter package and explain what needs to be filtered for various situations (for queries, for URLs, etc)
 
−
* [[How to use the registry package]]
 
−
* [[How to use JSimpleXML]]
 
−
** How to load and store XML files and how to work with them
 
−
* [[How to use JDate]]
 
−
** What JDate does and how to use it...
 
−
* [[How to add CSRF anti-spoofing to forms]]
 
−
** How to use JHTML::_( 'form.token' ) and token checking to secure components
 
−
* [[How to add breadcrumbs]]
 
−
* [[How to use the JTable class]]
 
−
* [[How to create component feeds]] (RSS/ATOM)
 
−
* [[How to create PDF views]]
 
−
* [[How to send email from components]]
 
−
* [[What's available in the JFactory class]]
 
−
* [[How to generate paths for client side and server side]]
 
−
* How to access information from the request/browser
 
−
** This focuses on using the JBrowser class to retrieve information about the features available in the user's browser.
 
−
* [[How to create a search plugin]] (To be reviewed)
 
−
* [[How to create a content plugin]] (To be reviewed)
 
−
* [[How to create an editor plugin]]
 
−
* [[How to create a system plugin]]
 
−
* [[What can be done with a user plugin]]
 
−
* [[How to create a module]]
 
−
* [[How to create a stand-alone application using the Joomla! Framework]]
 
−
* [[How to work with parameters]]
 
−
* [[Using the JToolBar class in the frontend]]
 
−
* [[How to create a custom button]]
 
−
* [[How to use the editor in a component]]
 
−
* [[How to use the JPane classes in a component]]
 
−
* [[How to cloak email addresses]]
 
  
−
==Audience: Testers==
+
===Testers===
 
These people may be testing functionality from a user perspective; or they may be developers testing the code itself.
 
These people may be testing functionality from a user perspective; or they may be developers testing the code itself.
  
−
* Automated testing.
+
<small>List of all articles belonging to the categories "Need review" AND "Testing"</small>
 +
<DPL>
 +
noresultsheader=\n* Yeah! There were no articles found! This category must be empty.
 +
notnamespace=J2.5
 +
category=Needs%
 +
categorymatch=%Testing%
 +
include={version}:1 
 +
format  = ,\n* [[%PAGE%|%TITLE%]]&nbsp;²{JVer/multi¦,}²,
 +
</DPL>
  
−
==Audience: Various==
+
== Under Construction ==
−
Stuff that pertains to multiple audiences.
+
Articles which are under construction and need help getting to the review point.
  
−
* [[Joomla! 1.5 Template Tutorials Project]]
+
<small>List of all articles belonging to the category "Under Construction"</small>
−
* Integrate GHOP student work
+
<DPL>
−
* [[:Category:Landing Pages|Landing pages in this wiki]]
+
noresultsheader=No articles found\n 
−
* Pages that define terms can be added to the [[:Category:Glossary|Glossary]] category by adding <nowiki>[[Category:Glossary]]</nowiki> at the end of the page.
+
category=Article under construction
 +
include={version}:1 
 +
format  = ,\n* [[%PAGE%|%TITLE%]]&nbsp;²{JVer/multi¦,}²,
 +
</DPL>
  
−
==Audience: Documentors==
+
===Documentors===
 
This is meta documentation for use by the Documentation Working Group and other documentors.
 
This is meta documentation for use by the Documentation Working Group and other documentors.
  
−
[[Project:MediaWiki setup notes|MediaWiki setup notes]]
+
* [[Project:MediaWiki setup notes|MediaWiki setup notes]]
  
 
[[Category:DocSprint]]
 
[[Category:DocSprint]]
 
[[Category:Documentation Wiki Information]]
 
[[Category:Documentation Wiki Information]]

Revision as of 12:41, 16 October 2014

Reference Information

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

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. Then don't forget to remove it again when you have finished! Thank you.

Where to start? Confused? Confused.png[edit]

Looking for a topic to write about? Please consider helping complete an article under construction listed here first before creating any new articles. We are trying to organise our content, find holes, note and fix them, or document future features being released.

For small tasks look in the Quick Tasks (below). These will mainly be editing for misspelling, grammar, and flow. 5 minute reads, and they can be cleared out. There are category lists about many topics of need on docs, here are a few:

Otherwise, look down this page and browse the links.

Quick Tasks (Reviews and Images)[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 because they are high traffic pages. Please remove them once they have been edited.

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.

New Joomla Features[edit]

This list if for features just released or being released in the near future. Please add to the list by editing the section with an appropriate, descriptive title using the J#.x: prefix (only if it is version specific), e.g. [[J3.x:A Descriptive Title]]. Then add a short summary of what it should contain.

J3.4 Release[edit]

Documentation Help by Audiences[edit]

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[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)"

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"

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"

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"

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"

Documentors[edit]

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

Retrieved from "https://docs.joomla.org/index.php?title=JDOC:Joomla!_Doc_Sprints/Start_Here&oldid=127448"