Joomla! Documentation - Changes related to "Category:Documentation Wiki Information" [en]

JDOC:Joomla! Doc Camp/Start Here

2013-06-19T09:03:31Z

‎Audience: Third-party Developers: Update the link

JDOC:Joomla! Doc Camp/Start Here

2013-06-18T13:52:32Z

added Category:Documentation Wiki Information using HotCat

JDOC:How to Contribute to Joomla! Documentation

2013-06-13T23:56:07Z

‎Helping with Help Screens: editing and improving

Help:Contents

2013-06-13T18:33:28Z

text updates

JDOC:How to Contribute to Joomla! Documentation

2013-06-13T18:29:59Z

‎Things to Remember: more info

JDOC:Namespaces

2013-06-13T14:42:52Z

improving

JDOC:How to Contribute to Joomla! Documentation

2013-06-13T14:28:01Z

‎Things to Remember: more text added

JDOC:How to Contribute to Joomla! Documentation

2013-06-12T23:40:26Z

new Project page

New page

{{under construction}}

=Introduction=
* To edit the Joomla! Documentation Wiki, you will need a user account. If you don't already have one, you may register on [[Special:UserLogin|here]]. All a willing contributor needs is a valid email address to register. After confirming your email address you will have immediate permission to edit any page except for a few that are protected because they are high profile spam targets or high web traffic.
* '''Important!''' - You should review the [[JDOC:Wiki policy|Wiki policy]] before you start.
* If you'd like something to be edited, but you're not sure what to write exactly, use talk pages to add comments to pages.
* There are several ways to get help.

=Where do I start?=
You are free to work on any aspect of the documentation that takes your fancy, but here are some suggestions below for stuff that really needs some love and attention. Don't worry, sometimes even the most seasoned wiki editors can get lost, distracted or confused about what to do next.

*There are a lot of pages of antiquity in the '[[:category:Cookie jar|Cookie jar]]' - they are all time stamped, some over 4 years old. The majority were never even started and pertain to Joomla! 1.5. Mark those articles with the {{tl|delete}} template you feel need to be deleted. Approximately once a week, a bot run will clean up the ones marked deleted unless someone objects on the talk page of the article.
*Have some fun and browse some articles and feel free to make use of the {{tl|delete}}, {{tl|merge}} or {{tl|JSplit}} templates on the articles. 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.
*Another area of similar to the 'Cookie jar' is our [[:Category:Joomla!_Wiki_need_pages|Needs pages]]. They are called 'Needs pages' because they are in need of various tasks to complete them. Some of these needs are simple tasks such as reviewing content, adding an image, more content or improvements. Pick a few, give them a little love and help others when they read the docs.
*Categorisation is always a something easy to do, necessary and in great demand on our wiki! [[Special:UncategorizedPages|Pages without categories]] are abundant, pick some titles you know and skip the ones you might not know right off. Categories are important because they help define the structure of the wiki and make it easier to fine information.
*Help pages, yes we know they are a lot of work, but necessary for beginners and even those with intermediate knowledge of Joomla! Joomla! 2.5 Help Screens are complete but Joomla! 3.x are still being worked on! The love you give them will be felt by many users worldwide. You can find the matrix of [[Help31:Help_screens|3.x Help Screens here]]. Some just need to be reviewed and marked complete in status, others need to be started, completed, have images uploaded(670px max width), etc. Make sure you read the [[Help31:Help_screens_styleguide|3.x Style Guide]]. The Help Screens are seen by many worldwide and it is important to maintain a similar style from help page to help page.
*Join the [[JDOC:Developer Tutorials Project|Developer Tutorials Project]] and share your knowledge. Sign your name using 4 tildes ( <nowiki>~~~~</nowiki> ) on the [[JDOC_talk:Developer Tutorials Project|Developer Tutorials Project]] page and list what you might be able to do. Feel free to add some [[JDOC:Developer Tutorials Project/Topics|tutorial topics]] to the suggested topics list.
*The docs team is also working on [[Beginner Tutorials]]. 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.

=Remember=

Don't forget to add the {{tl|inuse}} template to an article you are going to be working on for a long period of time, more than a minute. It helps to prevent editing conflicts.

<headertabs/>

JDOC:Docs Wiki Roadmap

2013-06-12T20:06:09Z

‎Nice to have eventually: updates

@@ Line 178: / Line 178: @@
 * [[How to create a stand-alone application using the Joomla! Framework]]
 * [[How to work with parameters]]
-* [[How to use the JToolBar class in the frontend]]
+* [[Using the JToolBar class in the frontend]]
 * [[How to create a custom button]]
 * [[How to use the editor in a component]]

← Older revision		Revision as of 13:52, 18 June 2013
Line 206:		Line 206:

	[[Category:DocCamp]]		[[Category:DocCamp]]
		+	[[Category:Documentation Wiki Information]]

@@ Line 1: / Line 1: @@
-=Introduction=
+=Before you start=
 If you are reading this page, the Docs Team hopes you will take the next steps to maintaining, improving and contributing to the Joomla! Project's Documentation. Our documentation is written by users, developers, and code contributors for the benefit of the same. There are many Open Source Projects using Mediawiki software succesfully for their project's documentation. The Mediawiki software allows for open collaboration, version control of pages, tracking changes similar to Git and a large base of extensions to extend the user interface. A wiki is '''hard to break''' with its excellent page history. Make a mistake and just undo or revert the page back to the previous version.
@@ Line 19: / Line 19: @@
 *Post a question on an administrator's or editor's talk page.
-=Where do I start?=
+=What Should I Do First?=
 ==Jump right in==
 Once you have a wiki account, you are free to work on any aspect of the documentation that takes your fancy. Don't worry, sometimes even the most seasoned wiki editors can get lost, distracted or confused about what to do next. Even the simplest contributions such as spelling corrections and grammar fixes are a tremendous help!
 ==Specific tasks==
@@ Line 31: / Line 33: @@
 *Categorisation is always a something easy to do, necessary and in great demand on our wiki! [[Special:UncategorizedPages|Pages without categories]] are abundant, pick some titles you know and skip the ones you might not know right off. Categories are important because they help define the structure of the wiki and make it easier to find articles.
 *The docs team is also working on [[Beginner Tutorials]]. 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.
 *Join the [[JDOC:Developer Tutorials Project|Developer Tutorials Project]] and share your knowledge. Sign your name using 4 tildes ( <nowiki>~~~~</nowiki> ) on the [[JDOC_talk:Developer Tutorials Project|Developer Tutorials Project]] page and list what you might be able to do. Feel free to add some [[JDOC:Developer Tutorials Project/Topics|tutorial topics]] to the suggested topics list.
 =Things to Remember=

@@ Line 4: / Line 4: @@
 :If you are new to the use of '''''Wikis''''' and its simple markup to create pages, then you can use the:
 :*[[Help:Cheatsheet|JDOC's Wiki Cheatsheet]] to learn the basic syntax commands.
-:For a more detailed use of Mediawiki software, you should consult the official:
+:*'''[http://meta.wikimedia.org/wiki/Help:Contents Mediawiki Handbook]''' for a more detailed use of Mediawiki software.
-:*'''[http://meta.wikimedia.org/wiki/Help:Contents Mediawiki Handbook]'''
+:*Users of other wikis (e.g. DokuWiki/JD-Wiki) should make themselves familiar with the slightly different [http://meta.wikimedia.org/wiki/Help:Wikitext_reference text formatting and wikitext syntax].
 Users of other wikis (e.g. DokuWiki/JD-Wiki) should make themselves familiar with the slightly different [http://meta.wikimedia.org/wiki/Help:Wikitext_reference text formatting and wikitext syntax].
 ==Recommended readings==

@@ Line 1: / Line 1: @@
 =Introduction=
-If you are reading this page, the Docs Team hopes you will take the next steps to maintaining, improving and contributing to the Joomla! Project's Documentation. Our documentation is written by users, developers, and code contributors for the benefit of the same. There are many Open Source Projects using Mediawiki software succesfully for their project's documentation. The Mediawiki software allows for open collaboration, version control of pages, tracking changes similar to Git and a large base of extensions to extend the user interface. A wiki is '''hard to break''' with page history. Make a mistake and just undo or revert the page back to the previous version.
+If you are reading this page, the Docs Team hopes you will take the next steps to maintaining, improving and contributing to the Joomla! Project's Documentation. Our documentation is written by users, developers, and code contributors for the benefit of the same. There are many Open Source Projects using Mediawiki software succesfully for their project's documentation. The Mediawiki software allows for open collaboration, version control of pages, tracking changes similar to Git and a large base of extensions to extend the user interface. A wiki is '''hard to break''' with its excellent page history. Make a mistake and just undo or revert the page back to the previous version.
 ==What you need==
-* To edit the Joomla! Documentation Wiki, you will need a user account. If you don't already have one, you may register on [[Special:UserLogin|here]]. All a willing contributor needs is a valid email address to register. After confirming your email address you will have immediate permission to edit any page except for a few that are protected because they are high profile spam targets or high web traffic.
+* To edit the Joomla! Documentation Wiki, you will need a user account. If you don't already have one, you may '''[[Special:UserLogin|register for one here]]'''. All a willing contributor needs is a valid email address to register. After confirming your email address you will have immediate permission to edit any page except for a few that are protected. These are pages which are high profile spam targets or highly view documentation pages.
-* '''Important!''' - You should review the [[JDOC:Wiki policy|Wiki policy]] before you start.
+* '''Important!''' - You should review the Joomla! Docs '''[[JDOC:Wiki policy|Wiki policy]]''' before you start editing.
-* If you'd like something to be edited, but you're not sure what to write exactly, use talk pages to add comments to pages.
+* If you want to edit a page but you're not sure what to write exactly, use talk pages to add comments to pages. Alternatively, you can join the '''[http://groups.google.com/group/joomla-docs Docs mail list]'''.
 ==Help, I don't know Wiki Markup!==
@@ Line 39: / Line 37: @@
 Here a a few things to remember as a Joomla! Docs contributor.
 *Write articles with a sense they will translated to another language. Using slang or local dialect may not translate to another language or its inferences be understood.
 *Don't be afraid to download and read the general [http://help.joomla.org/files/Editorial%20Style%20Guide%20v1.0.5.pdf Editorial Style Guide] (PDF) that applies to all Joomla! Documentation. There are helpful hints on how to write for Joomla! Documentation.
@@ Line 45: / Line 44: @@
 <headertabs/>

@@ Line 15: / Line 15: @@
 * [[Need example
 * [[Need example 2
 ===User===
 When you create an account, you are given a personal user page. It would look something like this, <nowiki>User:DocsUser</nowiki> or User: followed by whatever username you used to register on the wiki. Think of it as your own personal page. A place to experiment with wiki code, new pages or pages you are thinking of creating.
@@ Line 23: / Line 25: @@
 Pages in this namespace are a like the title of the namespace states, a portal. Portal pages can take a user to many pages which are grouped together by a subject, such as [[Portal:Bug Squad]]. A page for all things relevant to being a Joomla! Bug Squad member.
 [[Category:Documentation Wiki Information]]

@@ Line 2: / Line 2: @@
 =Introduction=
 * To edit the Joomla! Documentation Wiki, you will need a user account. If you don't already have one, you may register on [[Special:UserLogin|here]]. All a willing contributor needs is a valid email address to register. After confirming your email address you will have immediate permission to edit any page except for a few that are protected because they are high profile spam targets or high web traffic.
 * '''Important!''' - You should review the [[JDOC:Wiki policy|Wiki policy]] before you start.
 * If you'd like something to be edited, but you're not sure what to write exactly, use talk pages to add comments to pages.
-* There are several ways to get help.
 =Where do I start?=
-You are free to work on any aspect of the documentation that takes your fancy, but here are some suggestions below for stuff that really needs some love and attention. Don't worry, sometimes even the most seasoned wiki editors can get lost, distracted or confused about what to do next.
+==Jump right in==
-*There are a lot of pages of antiquity in the '[[:category:Cookie jar|Cookie jar]]' - they are all time stamped, some over 4 years old. The majority were never even started and pertain to Joomla! 1.5. Mark those articles with the {{tl|delete}} template you feel need to be deleted. Approximately once a week, a bot run will clean up the ones marked deleted unless someone objects on the talk page of the article.
+==Specific tasks==
-*Have some fun and browse some articles and feel free to make use of the {{tl|delete}}, {{tl|merge}} or {{tl|JSplit}} templates on the articles. 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.
+Here are just a few suggestions below that really need some love and attention.
-*Another area of similar to the 'Cookie jar' is our [[:Category:Joomla!_Wiki_need_pages|Needs pages]]. They are called 'Needs pages' because they are in need of various tasks to complete them. Some of these needs are simple tasks such as reviewing content, adding an image, more content or improvements. Pick a few, give them a little love and help others when they read the docs.
-*Categorisation is always a something easy to do, necessary and in great demand on our wiki! [[Special:UncategorizedPages|Pages without categories]] are abundant, pick some titles you know and skip the ones you might not know right off. Categories are important because they help define the structure of the wiki and make it easier to fine information.
+*Check the ''''[[:category:Cookie jar|Cookie jar]]'''' - The Docs Team loves an empty 'cookie jar' so please grab a cookie and make it disappear.
-*Help pages, yes we know they are a lot of work, but necessary for beginners and even those with intermediate knowledge of Joomla! Joomla! 2.5 Help Screens are complete but Joomla! 3.x are still being worked on! The love you give them will be felt by many users worldwide. You can find the matrix of [[Help31:Help_screens|3.x Help Screens here]]. Some just need to be reviewed and marked complete in status, others need to be started, completed, have images uploaded(670px max width), etc. Make sure you read the [[Help31:Help_screens_styleguide|3.x Style Guide]]. The Help Screens are seen by many worldwide and it is important to maintain a similar style from help page to help page.
+*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 {{tl|delete}}, {{tl|merge}} or {{tl|JSplit}} templates on the articles. ''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.''
-*Join the [[JDOC:Developer Tutorials Project|Developer Tutorials Project]] and share your knowledge. Sign your name using 4 tildes ( <nowiki>~~~~</nowiki> ) on the [[JDOC_talk:Developer Tutorials Project|Developer Tutorials Project]] page and list what you might be able to do. Feel free to add some [[JDOC:Developer Tutorials Project/Topics|tutorial topics]] to the suggested topics list.
+*Another area of similar to the 'Cookie jar' is our [[:Category:Joomla!_Wiki_need_pages|Needs pages]]. They are called 'Needs pages' because they are in need of various tasks to complete them. Some of these needs are simple tasks such as reviewing content, adding an image, more content or improvements. Pick a few, give them a little love. This is a tremendous help to Joomla! users who rely on and read the docs.
 *The docs team is also working on [[Beginner Tutorials]]. 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.
-=Remember=
+=Things to Remember=
-Don't forget to add the {{tl|inuse}} template to an article you are going to be working on for a long period of time, more than a minute. It helps to prevent editing conflicts.
+*Write articles with a sense they will translated to another language. Using slang or local dialect may not translate to another language or its inferences be understood.
 <headertabs/>

@@ Line 60: / Line 60: @@
 **<strike> Improved look</strike>
 **<strike> Integration with administration for VEL notifications of installed Extensions.</strike>
-* Multilingual support
+* Multilingual support '''(Investigation underway)''' Translate Extension.
 ==Investigation==