http://docs.joomla.org/api.php?action=feedcontributions&user=Jinx&feedformat=atom 2013-06-19T17:14:46Z User contributions MediaWiki 1.19.3 http://docs.joomla.org/Localisation 2008-01-21T13:40:14Z

<p>Jinx: </p> <hr /> <div>{{review}}<br /> <br /> == Implementation of UTF-8 in Joomla! 1.5 ==<br /> <br /> ''This text is based on an article rewritten by former core team member David Gal for a German Linux publication.''<br /> <br /> UTF-8 is a variable length character encoding using one to four bytes per character, depending on the Unicode symbol. Four bytes may seem like a lot for one character, however, this is required only for special characters outside the Basic Multilingual Plane, which are generally very rare. The first byte (positions 0-127) is used for encoding ASCII which gives the character set full backward compatibility with ASCII.<br /> <br /> UTF-8 is becoming the standard and internationally accepted multilingual environment and is the preferred way to communicate non-ASCII characters over the Internet. Being a subset of Unicode, UTF-8 has the special benefit of using less space to store or transmit ASCII. As the bulk of Internet transmissions are using the 7 bit ASCII characters, UTF-8 encoding saves volume and bandwidth.<br /> <br /> It also provides a single encoding for all other characters that were previously implemented using 8 bit character codes hand-in-hand with a specific encoding table (i.e iso-8859-2) in order to know how to represent the character code. Up to now this basically limited Web page display to ASCII Latin characters plus one other language or set of diacritic Latin characters (accents and umlauts for example). UTF-8 now provides one code page for all languages.<br /> <br /> Migration to UTF-8 promises to be simple for existing ASCII texts as UTF-8 encoding for ASCII has no changes.<br /> <br /> === Implementing in Joomla! – a bit more than setting encoding to ‘utf-8’ ===<br /> <br /> Up to now in order to change from one encoding to another all that was required was to change the _ISO definition in the language file resulting in the ‘charset=myNewEncoding’ statement in the html meta tag. This was simple as all encodings were single-byte character encodings. For the entire Joomla! system, a character equals a byte and Joomla! didn’t really care what the character representation of the particular byte is.<br /> <br /> Now, in Joomla! 1.5, we are starting to use multi-byte characters and not only that – some are one byte long and some are 3 bytes long. How does this affect Joomla! and what is required to truly be able to state that Joomla! supports UTF-8?<br /> <br /> === There are four affected areas: ===<br /> <br /> # The database needs to support utf-8 data storage. For example: a text field of type varchar was given a length of 20 with the intention of being able to store up to 20 characters – which also meant 20 bytes. Now, with UTF-8, 20 characters might mean between 20 and 60 bytes. The database needs to be able to adjust accordingly. Fortunately MySQL version 4.1.2 and up, support UTF-8.<br /> # The connection between the Joomla! application and the database needs to know the encoding of the data in order to know whether encoding translation is required. (There are cases where the application uses one encoding and the database uses another).<br /> # The html page needs to know which encoding it carries. This is trivial and all that is required is that the html meta tags will show that the encoding is ‘utf-8’.<br /> # Joomla’s PHP string handling functions need to be UTF-8 aware. This is not at all trivial as PHP’s regular string functions are all single-byte aware and a special set of functions is needed.<br /> <br /> === The challenges and the solutions ===<br /> <br /> The first major challenge was the fact that there are still many hosts that are running MySQL version 4.0.x and older databases. These do not have UTF-8 support. It is possible to store UTF-8 data in non UTF-8 tables. As far as the database is concerned it is storing bytes and returning them to the application when needed.<br /> <br /> However, as already mentioned, there is a possibility that the user will want to store a 20 character field that holds UTF-8 characters that are not in the regular ASCII area. If these are committed to a varchar (20) database field – the data will be truncated. This is not only a problem with non “Latin character�? languages (that are normally in the multi-byte area) but also with all European languages with possible the exception of English. Every one of these languages has some special Latin characters (accents and umlauts for example) that are now multi-byte characters. The word ‘käse’ is now 5 bytes long!<br /> <br /> The core team rightfully decided that Joomla! 1.5 should also be able to work on older databases and not only that – the backward compatibility should be transparent to the user. The installer now checks for the version of MySQL – if it is version 4.1.2 and up, then UTF-8 tables are created with the user being able to choose the desired collation. If the database is not supporting UTF-8 then the installer actually runs a separate script creating a database structure that provides extra storage space for potentially longer strings. This is anticipated to eliminate the danger of data truncation by the database.<br /> <br /> The second major challenge relates to the lack of UTF-8 support in PHP. All standard string functions in PHP are only able to work with single-byte characters. Using these functions on UTF-8 encoded data can result in logical failures and also in data corruption.<br /> <br /> The problem lies with the fact that until PHP 6 is released, there is no comprehensive native UTF-8 support in PHP. There is a multi-byte extension named ‘mbstring’ which exists from version 4.1 but it is not loaded by default. In addition is also serves other multi-byte encodings such as some Far Eastern languages. This means that it may be present but not set to the correct settings for UTF-8. An additional extension named ‘iconv’, which has some parallel capability, is present in PHP 5 but optional and missing some functions in PHP 4.<br /> <br /> Here again, the core team decided to vote for full backward compatibility and for the solution to be transparent to the user. The solution is a combination of either using PHP provided functions, if they are present, or using a special library of UTF-8 aware string functions, if no PHP native functions are available. This provides the best performance (PHP functions available) together will complete backward compatibility. A Joomla String Class provides this functionality and it will be included in the API for third party developers.<br /> <br /> There is no user configuration or setup required regarding PHP UTF-8 support. There is one small exception to this rule which could theoretically occur if, in the host, one or two of the mbstring settings (that cannot be changed from within code) are set to a value that is adverse to UTF-8. The installer will identify this and advise on how to change the setting locally using .htaccess.<br /> <br /> === Migration ===<br /> <br /> Considering that data will, in most cases, need to be converted to UTF-8, it will be recommended to migrate existing data to a freshly installed Joomla! 1.1 site and not to perform upgrades of existing Joomla! 1.0.x sites. Specific migration guidance will be provided with the release.<br /> <br /> === The quantum jump ===<br /> <br /> Joomla! 1.5 will take a huge jump ahead of the rest of the CMS pack with its Internationalisation features. UTF-8 is undoubted, the big discriminator – all languages with one encoding. In addition, RTL support and the language packs for back-end, installer and help system, make Joomla! 1.5 a complete package for use in any language or combination of languages. JoomFish will be the icing on the cake.<br /> <br /> == Language codes - RFC 3066 ==<br /> <br /> Providing decent localisation support for Joomla - the kind of support that will carry smoothly across to the work of all extension providers (from language packs to components, modules and plugins), requires a certain amount of attention to some nitty gritty details. A questions that pops up are: “How do we identify a language?” - followed by: “How do we provide a consistent naming convention?” and: “How will everyone know about this?”<br /> <br /> Simple - we need a convention - preferably public - hopefully without ambiguity - and it should be kept current.<br /> <br /> A little bit of digging unearthed RFC 3066 and a decision was made to use it as the convention for language identification in Joomla as of version 1.5.<br /> <br /> This results in the following conventions for the language names :<br /> # The delimiter between the subtags should be the HYPHEN / MINUS character and not the UNDERSCORE character<br /> # The first tag with the language tag (based on ISO 639) should use the TWO letter code for a language and not the THREE letter code. The THREE letter code may only be used if a TWO letter code does not exist for the language</div>

Jinx http://docs.joomla.org/Localisation 2008-01-21T13:39:50Z

<p>Jinx: New page: {{review}} ''This text is based on an article rewritten by former core team member David Gal for a German Linux publication.'' == Implementation of UTF-8 in Joomla! 1.5 == UTF-8 is a va...</p> <hr /> <div>{{review}}<br /> <br /> ''This text is based on an article rewritten by former core team member David Gal for a German Linux publication.''<br /> <br /> == Implementation of UTF-8 in Joomla! 1.5 ==<br /> <br /> UTF-8 is a variable length character encoding using one to four bytes per character, depending on the Unicode symbol. Four bytes may seem like a lot for one character, however, this is required only for special characters outside the Basic Multilingual Plane, which are generally very rare. The first byte (positions 0-127) is used for encoding ASCII which gives the character set full backward compatibility with ASCII.<br /> <br /> UTF-8 is becoming the standard and internationally accepted multilingual environment and is the preferred way to communicate non-ASCII characters over the Internet. Being a subset of Unicode, UTF-8 has the special benefit of using less space to store or transmit ASCII. As the bulk of Internet transmissions are using the 7 bit ASCII characters, UTF-8 encoding saves volume and bandwidth.<br /> <br /> It also provides a single encoding for all other characters that were previously implemented using 8 bit character codes hand-in-hand with a specific encoding table (i.e iso-8859-2) in order to know how to represent the character code. Up to now this basically limited Web page display to ASCII Latin characters plus one other language or set of diacritic Latin characters (accents and umlauts for example). UTF-8 now provides one code page for all languages.<br /> <br /> Migration to UTF-8 promises to be simple for existing ASCII texts as UTF-8 encoding for ASCII has no changes.<br /> <br /> === Implementing in Joomla! – a bit more than setting encoding to ‘utf-8’ ===<br /> <br /> Up to now in order to change from one encoding to another all that was required was to change the _ISO definition in the language file resulting in the ‘charset=myNewEncoding’ statement in the html meta tag. This was simple as all encodings were single-byte character encodings. For the entire Joomla! system, a character equals a byte and Joomla! didn’t really care what the character representation of the particular byte is.<br /> <br /> Now, in Joomla! 1.5, we are starting to use multi-byte characters and not only that – some are one byte long and some are 3 bytes long. How does this affect Joomla! and what is required to truly be able to state that Joomla! supports UTF-8?<br /> <br /> === There are four affected areas: ===<br /> <br /> # The database needs to support utf-8 data storage. For example: a text field of type varchar was given a length of 20 with the intention of being able to store up to 20 characters – which also meant 20 bytes. Now, with UTF-8, 20 characters might mean between 20 and 60 bytes. The database needs to be able to adjust accordingly. Fortunately MySQL version 4.1.2 and up, support UTF-8.<br /> # The connection between the Joomla! application and the database needs to know the encoding of the data in order to know whether encoding translation is required. (There are cases where the application uses one encoding and the database uses another).<br /> # The html page needs to know which encoding it carries. This is trivial and all that is required is that the html meta tags will show that the encoding is ‘utf-8’.<br /> # Joomla’s PHP string handling functions need to be UTF-8 aware. This is not at all trivial as PHP’s regular string functions are all single-byte aware and a special set of functions is needed.<br /> <br /> === The challenges and the solutions ===<br /> <br /> The first major challenge was the fact that there are still many hosts that are running MySQL version 4.0.x and older databases. These do not have UTF-8 support. It is possible to store UTF-8 data in non UTF-8 tables. As far as the database is concerned it is storing bytes and returning them to the application when needed.<br /> <br /> However, as already mentioned, there is a possibility that the user will want to store a 20 character field that holds UTF-8 characters that are not in the regular ASCII area. If these are committed to a varchar (20) database field – the data will be truncated. This is not only a problem with non “Latin character�? languages (that are normally in the multi-byte area) but also with all European languages with possible the exception of English. Every one of these languages has some special Latin characters (accents and umlauts for example) that are now multi-byte characters. The word ‘käse’ is now 5 bytes long!<br /> <br /> The core team rightfully decided that Joomla! 1.5 should also be able to work on older databases and not only that – the backward compatibility should be transparent to the user. The installer now checks for the version of MySQL – if it is version 4.1.2 and up, then UTF-8 tables are created with the user being able to choose the desired collation. If the database is not supporting UTF-8 then the installer actually runs a separate script creating a database structure that provides extra storage space for potentially longer strings. This is anticipated to eliminate the danger of data truncation by the database.<br /> <br /> The second major challenge relates to the lack of UTF-8 support in PHP. All standard string functions in PHP are only able to work with single-byte characters. Using these functions on UTF-8 encoded data can result in logical failures and also in data corruption.<br /> <br /> The problem lies with the fact that until PHP 6 is released, there is no comprehensive native UTF-8 support in PHP. There is a multi-byte extension named ‘mbstring’ which exists from version 4.1 but it is not loaded by default. In addition is also serves other multi-byte encodings such as some Far Eastern languages. This means that it may be present but not set to the correct settings for UTF-8. An additional extension named ‘iconv’, which has some parallel capability, is present in PHP 5 but optional and missing some functions in PHP 4.<br /> <br /> Here again, the core team decided to vote for full backward compatibility and for the solution to be transparent to the user. The solution is a combination of either using PHP provided functions, if they are present, or using a special library of UTF-8 aware string functions, if no PHP native functions are available. This provides the best performance (PHP functions available) together will complete backward compatibility. A Joomla String Class provides this functionality and it will be included in the API for third party developers.<br /> <br /> There is no user configuration or setup required regarding PHP UTF-8 support. There is one small exception to this rule which could theoretically occur if, in the host, one or two of the mbstring settings (that cannot be changed from within code) are set to a value that is adverse to UTF-8. The installer will identify this and advise on how to change the setting locally using .htaccess.<br /> <br /> === Migration ===<br /> <br /> Considering that data will, in most cases, need to be converted to UTF-8, it will be recommended to migrate existing data to a freshly installed Joomla! 1.1 site and not to perform upgrades of existing Joomla! 1.0.x sites. Specific migration guidance will be provided with the release.<br /> <br /> === The quantum jump ===<br /> <br /> Joomla! 1.5 will take a huge jump ahead of the rest of the CMS pack with its Internationalisation features. UTF-8 is undoubted, the big discriminator – all languages with one encoding. In addition, RTL support and the language packs for back-end, installer and help system, make Joomla! 1.5 a complete package for use in any language or combination of languages. JoomFish will be the icing on the cake.<br /> <br /> == Language codes - RFC 3066 ==<br /> <br /> Providing decent localisation support for Joomla - the kind of support that will carry smoothly across to the work of all extension providers (from language packs to components, modules and plugins), requires a certain amount of attention to some nitty gritty details. A questions that pops up are: “How do we identify a language?” - followed by: “How do we provide a consistent naming convention?” and: “How will everyone know about this?”<br /> <br /> Simple - we need a convention - preferably public - hopefully without ambiguity - and it should be kept current.<br /> <br /> A little bit of digging unearthed RFC 3066 and a decision was made to use it as the convention for language identification in Joomla as of version 1.5.<br /> <br /> This results in the following conventions for the language names :<br /> # The delimiter between the subtags should be the HYPHEN / MINUS character and not the UNDERSCORE character<br /> # The first tag with the language tag (based on ISO 639) should use the TWO letter code for a language and not the THREE letter code. The THREE letter code may only be used if a TWO letter code does not exist for the language</div>

Jinx http://docs.joomla.org/JDOC:Joomla!_Doc_Camp/Start_Here 2008-01-21T13:24:35Z

<p>Jinx: /* Audience: Core Developers */</p> <hr /> <div>__NOTOC__<br /> {| cellspacing=&quot;0&quot; cellpadding=&quot;0&quot; style=&quot;margin:0em 0em 1em 0em; width:100%&quot;<br /> | style=&quot;width:50%; vertical-align:top; border:1px solid Gold; background-color: LightYellow;&quot; rowspan=&quot;1&quot;|<br /> &lt;div style=&quot;border-bottom:1px solid Gold; background-color:#ffffaa; padding:0.2em 0.5em 0.2em 0.5em; font-size:110%; font-weight:bold;&quot;&gt;Instructions&lt;/div&gt;<br /> &lt;div style=&quot;padding:0.4em 1em 0.3em 1em;&quot;&gt;<br /> 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.<br /> <br /> 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 &quot;text&quot; into a link, change it to &lt;nowiki&gt;&quot;[[text]]&quot;&lt;/nowiki&gt;. 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].<br /> <br /> '''When you begin editing a page please add &lt;nowiki&gt;{{inuse}}&lt;/nowiki&gt; 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.'''<br /> &lt;/div&gt;<br /> <br /> | style=&quot;padding:0em 0.5em 0em 0.5em;&quot; |<br /> <br /> | colspan=&quot;1&quot; style=&quot;width:50%; vertical-align:top; border:1px solid #abd5f5; background-color:#f1f5fc;&quot; |<br /> &lt;div style=&quot;border-bottom:1px solid #abd5f5; background-color:#d0e5f5; padding:0.2em 0.5em 0.2em 0.5em; font-size:110%; font-weight:bold;&quot;&gt;Reference Information&lt;/div&gt;<br /> &lt;div style=&quot;padding:1em 1em 1em 1em;&quot;&gt; &lt;!--Note: Top, right, bottom, left --&gt;<br /> * 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.<br /> * List of '''[[local wiki templates]]''' that can be used in your wiki pages. Templates reduce repetition and are the basis of modular documentation.<br /> * 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.<br /> * 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 [http://php.net/manual PHP documentation] or [[wikipedia:Main_Page|Wikipedia]].<br /> * Please read the '''[http://help.joomla.org/workshop/documents/Editorial%20Style%20Guide%20v1.0.5.pdf Joomla! Editorial Style Guide]'''.<br /> &lt;/div&gt;<br /> |}<br /> <br /> ==Where to start==<br /> Looking for a topic to write about? Well, for small tasks look in the Cookie Jar (below).<br /> <br /> There is also an [[Special:Wantedpages|automatically-generated list of empty pages]].<br /> <br /> Otherwise, look down this page and browse the links. Red links are empty pages. If there is a topic that you feel we have missed then feel free to add it here.<br /> <br /> ==Doc Camp Cookie Jar==<br /> 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.<br /> * [[Joomla!]] - basic introduction to what Joomla! is, why you might want to download it, and where to go to get more information.<br /> * [[Copying a Joomla website]]<br /> * [[Using an FTP client to upload files]]<br /> * [[Using a terminal session]]<br /> * [[Migrating from 1.0.x to 1.5 Stable]] - see [http://dev.joomla.org/component/option,com_jd-wiki/Itemid,/id,migration:migration-component/]<br /> <br /> We need some basic information on the following pages. Looking for a simple definition of the term with links to further information if required.<br /> * [[ACL]] (redirect to [[Access Control List]])<br /> * [[Access Control List]]<br /> * [[Admin]] (redirect to Administrator)<br /> * [[Administrator]]<br /> * [[Backup]]<br /> * [[Banner]]<br /> * [[Blog]]<br /> * [[Calendar]]<br /> * [[Configuration]] (redirect to [[Screen.config.15|Screen.config.15]])<br /> * [[CSS]]<br /> * [[Database]]<br /> * [[Events]]<br /> * [[Front page]]<br /> * [[Global configuration]] (redirect to [[Screen.config.15|Screen.config.15]])<br /> * [[Installer]]<br /> * [[Languages]]<br /> * [[LDAP]] as in Lightweight Directory Access Protocol<br /> * [[Module positions]]<br /> * [[PHP]]<br /> * [[Register globals]]<br /> * [[Requirements]]<br /> * [[Release]]<br /> * [[Restricted access]]<br /> * [[Screen Captures]]<br /> * [[Search]]<br /> * [[Security]]<br /> * [[session save path]]<br /> * [[Setup]]<br /> <br /> ==Audience: Users/Administrators==<br /> 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.<br /> <br /> * [[Installation notes for specific platforms]]<br /> * [[Help screens]].<br /> * [[Marketing Information]] such as features and benefits.<br /> * Create one or more demo/showcase sites then create tutorials explaining how each was put together. For inspiration see: [http://www.adobe.com/devnet/blueprint/]<br /> * [[Beginners|Absolute Beginners Guide to Joomla!]]<br /> * [[Beginners_(Concise) | Another Absolute Beginners Guide to Joomla!]]<br /> * [[Landing Pages]] for this wiki.<br /> * [[FAQs]] Frequently Asked Questions<br /> <br /> ==Audience: Web Designers==<br /> 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.<br /> <br /> * [[Accessibility]]<br /> * [[Beez]] - an accessible default template<br /> * [[Creating clickable background images using CSS]].<br /> * 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]].<br /> * [[jdoc statements]] for templates<br /> * Modify the [[favicon]]<br /> <br /> ==Audience: Core Developers==<br /> By &quot;core developers&quot; we mean developers who are contributing to the Joomla! core distribution which includes the core extensions as well as the Framework.<br /> <br /> * Developer guidelines.<br /> * [[Participating in the community]]: a brief description of how people can get involved.<br /> * Coding style and standards.<br /> * Secure coding guidelines.<br /> * Error message conventions.<br /> * Exception handling.<br /> * [[Patch submission guidelines]].<br /> * [[Filing bugs/issues]].<br /> * [[How to release a distribution tarball]].<br /> * Release numbering, compatibility and deprecation.<br /> * [[Localisation]] (L18N): an explanation of how localisation is implemented in Joomla! 1.5 and how to use it.<br /> * [[Routing]]: how it works and how to use it<br /> <br /> ==Audience: Third-party Developers==<br /> By &quot;third-party developers&quot; we mean developers who are working on extensions to Joomla! (components, modules, plugins and templates) which are made available separately from the Joomla! distribution.<br /> <br /> * Complete/update/review the wiki API reference (assumes this has been moved from DocuWiki to MediaWiki).<br /> * Update developer tutorials and how-to's currently on dev.joomla.org<br /> ** Review all material under the tutorials heading at http://dev.joomla.org/component/option,com_jd-wiki/Itemid,32/<br /> ** Recommend material to be migrated over to docs.joomla.org<br /> ** Update material that is to be migrated over to docs.joomla.org<br /> * [[How to debug your code]].<br /> ** 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.<br /> * [[Using the core parameter types]]<br /> * [[Creating custom XML parameter types]].<br /> ** 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.<br /> * [[Creating component preferences]] (ready for review).<br /> ** 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.<br /> * [[Adding JavaScript and CSS to the page]].<br /> ** 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.<br /> * [[Accessing the current user object]].<br /> ** 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.<br /> * [[Adding AJAX to your component]].<br /> ** 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).<br /> * [[Using JPagination in your component]] (frontend and backend).<br /> ** Describe the steps necessary to add pagination to a component using the JPagination class. Describe the differences between frontend and backend.<br /> * [[Creating a toolbar for your component]].<br /> * [[Adding configuration objects to modules and plugins]].<br /> * [[Storing data in the session between page loads]].<br /> * [[Using the caching system in your component]].<br /> * [[Creating a file uploader in your component]].<br /> * [[Suppressing output of extra HTML]].<br /> * [[Supporting plugins in your component]].<br /> ** Explain how to add triggers so that your component can fire custom events.<br /> * [[Adding multi-language support]].<br /> * [[Retrieving data from GET and POST requests]] - the Joomla! way.<br /> * [[Adding view layout configuration parameters]].<br /> ** Explain how to create an XML file that will allow users to configure views.<br /> * [[Using the installer API to support package installation]].<br /> ** Explain how to use the JInstaller API to install add-ons to components<br /> * [[How to implement XML-RPC in a component]]<br /> ** There are two ways to do this:<br /> *** Implement it using an XML-RPC plugin<br /> *** Implement it in the component itself using raw views<br /> * [[How to use the filesystem package]]<br /> * [[How to use the filter package]]<br /> ** Describe how and when to use the Filter package and explain what needs to be filtered for various situations (for queries, for URLs, etc)<br /> * [[How to use the registry package]]<br /> * [[How to use JSimpleXML]]<br /> ** How to load and store XML files and how to work with them<br /> * [[How to use JDate]]<br /> ** What JDate does and how to use it...<br /> * [[How to add CSRF anti-spoofing to forms]]<br /> ** How to use JHTML::_( 'form.token' ) and token checking to secure components<br /> * [[How to add breadcrumbs]]<br /> * [[How to use the JTable class]]<br /> * [[How to create component feeds]] (RSS/ATOM)<br /> * [[How to create PDF views]]<br /> * [[How to send email from components]]<br /> * [[What's available in the JFactory class]]<br /> * [[How to generate paths for client side and server side]]<br /> * How to access information from the request/browser<br /> ** This focuses on using the JBrowser class to retrieve information about the features available in the user's browser.<br /> * [[How to create a search plugin]] (To be reviewed)<br /> * [[How to create a content plugin]] (To be reviewed)<br /> * [[How to create an editor plugin]]<br /> * [[How to create a system plugin]]<br /> * [[What can be done with a user plugin]]<br /> * [[How to create a module]]<br /> * [[How to create a stand-alone application using the Joomla! Framework]]<br /> * [[How to work with parameters]]<br /> * [[How to use the JToolBar class in the frontend]]<br /> * [[How to create a custom button]]<br /> * [[How to use the editor in a component]]<br /> * [[How to use the JPane classes in a component]]<br /> * [[How to cloak email addresses]]<br /> <br /> ==Audience: Testers==<br /> These people may be testing functionality from a user perspective; or they may be developers testing the code itself.<br /> <br /> * Automated testing.<br /> <br /> ==Audience: Various==<br /> Stuff that pertains to multiple audiences.<br /> <br /> * [[Joomla! 1.5 Template Tutorials Project]]<br /> * Integrate GHOP student work<br /> * [[:Category:Landing Pages|Landing pages in this wiki]]<br /> * Pages that define terms can be added to the [[:Category:Glossary|Glossary]] category by adding &lt;nowiki&gt;[[Category:Glossary]]&lt;/nowiki&gt; at the end of the page.<br /> <br /> ==Audience: Documentors==<br /> This is meta documentation for use by the Documentation Working Group and other documentors.<br /> <br /> [[Project:MediaWiki setup notes|MediaWiki setup notes]]<br /> <br /> ==License==<br /> {{license}}<br /> <br /> [[Category:DocCamp]]</div>

Jinx http://docs.joomla.org/JDOC:Joomla!_Doc_Camp/Start_Here 2008-01-21T13:23:21Z

<p>Jinx: /* Audience: Core Developers */</p> <hr /> <div>__NOTOC__<br /> {| cellspacing=&quot;0&quot; cellpadding=&quot;0&quot; style=&quot;margin:0em 0em 1em 0em; width:100%&quot;<br /> | style=&quot;width:50%; vertical-align:top; border:1px solid Gold; background-color: LightYellow;&quot; rowspan=&quot;1&quot;|<br /> &lt;div style=&quot;border-bottom:1px solid Gold; background-color:#ffffaa; padding:0.2em 0.5em 0.2em 0.5em; font-size:110%; font-weight:bold;&quot;&gt;Instructions&lt;/div&gt;<br /> &lt;div style=&quot;padding:0.4em 1em 0.3em 1em;&quot;&gt;<br /> 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.<br /> <br /> 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 &quot;text&quot; into a link, change it to &lt;nowiki&gt;&quot;[[text]]&quot;&lt;/nowiki&gt;. 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].<br /> <br /> '''When you begin editing a page please add &lt;nowiki&gt;{{inuse}}&lt;/nowiki&gt; 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.'''<br /> &lt;/div&gt;<br /> <br /> | style=&quot;padding:0em 0.5em 0em 0.5em;&quot; |<br /> <br /> | colspan=&quot;1&quot; style=&quot;width:50%; vertical-align:top; border:1px solid #abd5f5; background-color:#f1f5fc;&quot; |<br /> &lt;div style=&quot;border-bottom:1px solid #abd5f5; background-color:#d0e5f5; padding:0.2em 0.5em 0.2em 0.5em; font-size:110%; font-weight:bold;&quot;&gt;Reference Information&lt;/div&gt;<br /> &lt;div style=&quot;padding:1em 1em 1em 1em;&quot;&gt; &lt;!--Note: Top, right, bottom, left --&gt;<br /> * 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.<br /> * List of '''[[local wiki templates]]''' that can be used in your wiki pages. Templates reduce repetition and are the basis of modular documentation.<br /> * 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.<br /> * 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 [http://php.net/manual PHP documentation] or [[wikipedia:Main_Page|Wikipedia]].<br /> * Please read the '''[http://help.joomla.org/workshop/documents/Editorial%20Style%20Guide%20v1.0.5.pdf Joomla! Editorial Style Guide]'''.<br /> &lt;/div&gt;<br /> |}<br /> <br /> ==Where to start==<br /> Looking for a topic to write about? Well, for small tasks look in the Cookie Jar (below).<br /> <br /> There is also an [[Special:Wantedpages|automatically-generated list of empty pages]].<br /> <br /> Otherwise, look down this page and browse the links. Red links are empty pages. If there is a topic that you feel we have missed then feel free to add it here.<br /> <br /> ==Doc Camp Cookie Jar==<br /> 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.<br /> * [[Joomla!]] - basic introduction to what Joomla! is, why you might want to download it, and where to go to get more information.<br /> * [[Copying a Joomla website]]<br /> * [[Using an FTP client to upload files]]<br /> * [[Using a terminal session]]<br /> * [[Migrating from 1.0.x to 1.5 Stable]] - see [http://dev.joomla.org/component/option,com_jd-wiki/Itemid,/id,migration:migration-component/]<br /> <br /> We need some basic information on the following pages. Looking for a simple definition of the term with links to further information if required.<br /> * [[ACL]] (redirect to [[Access Control List]])<br /> * [[Access Control List]]<br /> * [[Admin]] (redirect to Administrator)<br /> * [[Administrator]]<br /> * [[Backup]]<br /> * [[Banner]]<br /> * [[Blog]]<br /> * [[Calendar]]<br /> * [[Configuration]] (redirect to [[Screen.config.15|Screen.config.15]])<br /> * [[CSS]]<br /> * [[Database]]<br /> * [[Events]]<br /> * [[Front page]]<br /> * [[Global configuration]] (redirect to [[Screen.config.15|Screen.config.15]])<br /> * [[Installer]]<br /> * [[Languages]]<br /> * [[LDAP]] as in Lightweight Directory Access Protocol<br /> * [[Module positions]]<br /> * [[PHP]]<br /> * [[Register globals]]<br /> * [[Requirements]]<br /> * [[Release]]<br /> * [[Restricted access]]<br /> * [[Screen Captures]]<br /> * [[Search]]<br /> * [[Security]]<br /> * [[session save path]]<br /> * [[Setup]]<br /> <br /> ==Audience: Users/Administrators==<br /> 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.<br /> <br /> * [[Installation notes for specific platforms]]<br /> * [[Help screens]].<br /> * [[Marketing Information]] such as features and benefits.<br /> * Create one or more demo/showcase sites then create tutorials explaining how each was put together. For inspiration see: [http://www.adobe.com/devnet/blueprint/]<br /> * [[Beginners|Absolute Beginners Guide to Joomla!]]<br /> * [[Beginners_(Concise) | Another Absolute Beginners Guide to Joomla!]]<br /> * [[Landing Pages]] for this wiki.<br /> * [[FAQs]] Frequently Asked Questions<br /> <br /> ==Audience: Web Designers==<br /> 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.<br /> <br /> * [[Accessibility]]<br /> * [[Beez]] - an accessible default template<br /> * [[Creating clickable background images using CSS]].<br /> * 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]].<br /> * [[jdoc statements]] for templates<br /> * Modify the [[favicon]]<br /> <br /> ==Audience: Core Developers==<br /> By &quot;core developers&quot; we mean developers who are contributing to the Joomla! core distribution which includes the core extensions as well as the Framework.<br /> <br /> * Developer guidelines.<br /> * [[Participating in the community]]: a brief description of how people can get involved.<br /> * Coding style and standards.<br /> * Secure coding guidelines.<br /> * Error message conventions.<br /> * Exception handling.<br /> * [[Patch submission guidelines]].<br /> * [[Filing bugs/issues]].<br /> * [[How to release a distribution tarball]].<br /> * Release numbering, compatibility and deprecation.<br /> * [Localisation] (L18N): an explanation of how localisation is implemented in Joomla! 1.5 and how to use it.<br /> * [[Routing]]: how it works and how to use it<br /> <br /> ==Audience: Third-party Developers==<br /> By &quot;third-party developers&quot; we mean developers who are working on extensions to Joomla! (components, modules, plugins and templates) which are made available separately from the Joomla! distribution.<br /> <br /> * Complete/update/review the wiki API reference (assumes this has been moved from DocuWiki to MediaWiki).<br /> * Update developer tutorials and how-to's currently on dev.joomla.org<br /> ** Review all material under the tutorials heading at http://dev.joomla.org/component/option,com_jd-wiki/Itemid,32/<br /> ** Recommend material to be migrated over to docs.joomla.org<br /> ** Update material that is to be migrated over to docs.joomla.org<br /> * [[How to debug your code]].<br /> ** 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.<br /> * [[Using the core parameter types]]<br /> * [[Creating custom XML parameter types]].<br /> ** 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.<br /> * [[Creating component preferences]] (ready for review).<br /> ** 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.<br /> * [[Adding JavaScript and CSS to the page]].<br /> ** 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.<br /> * [[Accessing the current user object]].<br /> ** 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.<br /> * [[Adding AJAX to your component]].<br /> ** 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).<br /> * [[Using JPagination in your component]] (frontend and backend).<br /> ** Describe the steps necessary to add pagination to a component using the JPagination class. Describe the differences between frontend and backend.<br /> * [[Creating a toolbar for your component]].<br /> * [[Adding configuration objects to modules and plugins]].<br /> * [[Storing data in the session between page loads]].<br /> * [[Using the caching system in your component]].<br /> * [[Creating a file uploader in your component]].<br /> * [[Suppressing output of extra HTML]].<br /> * [[Supporting plugins in your component]].<br /> ** Explain how to add triggers so that your component can fire custom events.<br /> * [[Adding multi-language support]].<br /> * [[Retrieving data from GET and POST requests]] - the Joomla! way.<br /> * [[Adding view layout configuration parameters]].<br /> ** Explain how to create an XML file that will allow users to configure views.<br /> * [[Using the installer API to support package installation]].<br /> ** Explain how to use the JInstaller API to install add-ons to components<br /> * [[How to implement XML-RPC in a component]]<br /> ** There are two ways to do this:<br /> *** Implement it using an XML-RPC plugin<br /> *** Implement it in the component itself using raw views<br /> * [[How to use the filesystem package]]<br /> * [[How to use the filter package]]<br /> ** Describe how and when to use the Filter package and explain what needs to be filtered for various situations (for queries, for URLs, etc)<br /> * [[How to use the registry package]]<br /> * [[How to use JSimpleXML]]<br /> ** How to load and store XML files and how to work with them<br /> * [[How to use JDate]]<br /> ** What JDate does and how to use it...<br /> * [[How to add CSRF anti-spoofing to forms]]<br /> ** How to use JHTML::_( 'form.token' ) and token checking to secure components<br /> * [[How to add breadcrumbs]]<br /> * [[How to use the JTable class]]<br /> * [[How to create component feeds]] (RSS/ATOM)<br /> * [[How to create PDF views]]<br /> * [[How to send email from components]]<br /> * [[What's available in the JFactory class]]<br /> * [[How to generate paths for client side and server side]]<br /> * How to access information from the request/browser<br /> ** This focuses on using the JBrowser class to retrieve information about the features available in the user's browser.<br /> * [[How to create a search plugin]] (To be reviewed)<br /> * [[How to create a content plugin]] (To be reviewed)<br /> * [[How to create an editor plugin]]<br /> * [[How to create a system plugin]]<br /> * [[What can be done with a user plugin]]<br /> * [[How to create a module]]<br /> * [[How to create a stand-alone application using the Joomla! Framework]]<br /> * [[How to work with parameters]]<br /> * [[How to use the JToolBar class in the frontend]]<br /> * [[How to create a custom button]]<br /> * [[How to use the editor in a component]]<br /> * [[How to use the JPane classes in a component]]<br /> * [[How to cloak email addresses]]<br /> <br /> ==Audience: Testers==<br /> These people may be testing functionality from a user perspective; or they may be developers testing the code itself.<br /> <br /> * Automated testing.<br /> <br /> ==Audience: Various==<br /> Stuff that pertains to multiple audiences.<br /> <br /> * [[Joomla! 1.5 Template Tutorials Project]]<br /> * Integrate GHOP student work<br /> * [[:Category:Landing Pages|Landing pages in this wiki]]<br /> * Pages that define terms can be added to the [[:Category:Glossary|Glossary]] category by adding &lt;nowiki&gt;[[Category:Glossary]]&lt;/nowiki&gt; at the end of the page.<br /> <br /> ==Audience: Documentors==<br /> This is meta documentation for use by the Documentation Working Group and other documentors.<br /> <br /> [[Project:MediaWiki setup notes|MediaWiki setup notes]]<br /> <br /> ==License==<br /> {{license}}<br /> <br /> [[Category:DocCamp]]</div>

Jinx http://docs.joomla.org/Filing_bugs_and_issues 2008-01-21T12:28:22Z

<p>Jinx: </p> <hr /> <div>{{review}}<br /> <br /> == Reporting bugs ==<br /> <br /> To report a bug in the Joomla! bug trackers, one has to create an &quot;artefact&quot;. Once this artefact is created, the developers will check the validity of it and act accordingly.<br /> <br /> === Register an Account at joomlacode.org ===<br /> [http://joomlacode.org/gf/account/?action=UserAdd Register]<br /> <br /> === Access the joomla! development bug tracker. ===<br /> <br /> *[http://joomlacode.org/gf/project/joomla/tracker/?action=TrackerItemBrowse&amp;tracker_id=32 Joomla! 1.5 Bug Tracker]<br /> *[http://joomlacode.org/gf/project/joomla/tracker/?action=TrackerItemBrowse&amp;tracker_id=5782 Joomla! 1.0 Bug Tracker]<br /> <br /> === Check to see if the bug you want to report is already reported. ===<br /> <br /> A series of filters display the artifacts. Make sure Priority is set to &quot;Any&quot;, Assignee to &quot;Any&quot; and Status to &quot;Any&quot;, other filters to nothing. Mouse over the title of the artefacts to check their contents. If the issue you are experiencing is not already reported, click on the bottom-right Button &quot;Add new Tracker Item&quot;.<br /> <br /> A new screen will display and there, the more information you give, the easier it is for the developers.<br /> <br /> Fill as many fields as you can.<br /> <br /> * Priority : Use the default &quot;Medium&quot; except if you know the code enough to make another choice.<br /> * PHP : Choose the version you are testing on. You can find this information by clicking the Menu &quot;Help&quot;-&gt;&quot;System Info&quot; in the Administrator back-end of Joomla!<br /> * Estimated Time : Leave this blank.<br /> * Build : Type here the #SVN number if you know it, or Nightly Build date, or Version used if using a Released version.<br /> * Browser : Self-explanatory.<br /> * Database : The version of MySQL is also available in &quot;Help&quot; -&gt; &quot;System Info&quot;.<br /> * Status : Leave this to &quot;Open&quot;.<br /> * Percent Complete : Leave this blank.<br /> * Category : This one is more tricky. Use &quot;Administration&quot; if you do not know better.<br /> * Customer : Use &quot;User&quot; if the issue is in front-end, &quot;Developer&quot; if the issue concerns an extension you are developing, &quot;Administrator&quot; in other cases.<br /> * Web Server : The version/server type is also available in &quot;Help&quot; -&gt; &quot;System Info&quot;.<br /> <br /> === Provide a summary ===<br /> <br /> Describe in a few words the issues you are having. It is generally a good idea to use existing artefacts as examples if this is your first time reporting a bug.<br /> <br /> Examples:<br /> <br /> * Front-end: Warning such and such.<br /> * Back-end: Unable to save article when &quot;nameofplugin&quot; is published.<br /> <br /> Note: Take care to be descriptive in your summary as this is the first thing the developers will see when they are perusing the tracker for something to fix.<br /> <br /> === Provide details about the bug ===<br /> <br /> This is the most important part of reporting the bug. Describe here step by step how you got the error you are noticing.<br /> <br /> The more details, the better.<br /> <br /> Examples:<br /> <br /> A. When I enabled &quot;nameofplugin&quot;, no article can be saved. These are the plugins enabled at the same time. SEF is on (or Off). My site is in a sub-folder. I also remark that... etc. Files such and such are the issues IMHO (if you know what you are talking about).<br /> <br /> B. Back-end. Clicking on &quot;menu_name&quot; Menu. Page opened is blank. Any other menu works OK. etc.<br /> <br /> C. Back-end. Content -&gt; Article Manager (The -&gt; means you click on a submenu). Editing a non-categorized Article. Section dropdown does not display the sections available (or Editor is going over the right column for parameters, or Can't save article after changing a parameter [describe parameter], etc.<br /> <br /> D. I have such an such issue when doing this and that. By changing this code [code proposed] in file [name and hierarchy of file], line(s) #, the issue looks solved on my settings.<br /> <br /> === Add an attachement to your report ===<br /> <br /> To better describe the issue or/and propose a fix, you can add attachments to the artefact you are creating by using the &quot;Browse&quot; buttons at the bottom of the screen.<br /> A screen capture of the page(s) concerned helps a lot. If you can, try to optimise the size of the image through an image editor.<br /> If you know what part(s) of the code base to change, a patch [patches] or a full file where your changes are WELL shown will help the developers to solve the problem quicker.<br /> <br /> === Finish and send in the report ===<br /> <br /> You will receive an e-mail confirming that you posted the artefact. When someone comments or asks for supplementary details or solves the issue, you will receive a notification e-mail and may reply if needed.<br /> <br /> === Extra tips and tricks ===<br /> <br /> Well-written bug reports are incredibly helpful. However, there's a certain amount of overhead involved in working with any bug tracking system, so your help in keeping our ticket tracker as useful as possible is appreciated. In particular:<br /> <br /> * Do read the [http://docs.joomla.org/FAQs FAQ] to see if your issue might be a well-known question.<br /> * Do search [http://joomlacode.org/gf/project/joomla/tracker/ the tracker] to see if your issue has already been filed.<br /> * Do ask on [http://forum.joomla.org/index.php/board,199.0.html testing forums] first if you're not sure if what you're seeing is a bug.<br /> * Do write complete, reproducible, specific bug reports. Include as much information as you possibly can, complete with code snippets, test cases, etc. A minimal example that illustrates the bug in a nice small test case is the best possible bug report.<br /> * Don't use the tracker system to ask support questions. Use the [http://forum.joomla.org/ joomla forums], or the [irc://irc.freenode.net/joomla #joomla] IRC channel on freenode for that.<br /> * Don't use the trackers to make large-scale feature requests. We like to discuss any big changes to Joomla's core on the [http://forum.joomla.org/index.php#6 developers forums] before actually working on them.<br /> * Don't reopen issues that have been marked &quot;not a bug&quot;. This mark means that the decision has been made that we can't or won't fix this particular issue. If you're not sure why, please ask on developer forums.<br /> * Don't use the tracker for lengthy discussions, because they're likely to get lost. If a particular artifcact is controversial, please move discussion to [http://forum.joomla.org/index.php#6 developer forums].<br /> <br /> == Reporting security issues ==<br /> <br /> Report security issues to security [at] joomla [dot] org. This is a private list only open to long-time, highly trusted Joomla developers, and its archives are not publicly readable.<br /> <br /> In the event of a confirmed vulnerability in Joomla itself, we will take the following actions:<br /> <br /> * Acknowledge to the reporter that we've received the report and that a fix is forthcoming. We'll give a rough timeline and ask the reporter to keep the issue confidential until we announce it.<br /> * Halt all other development as long as is needed to develop a fix, including patches against the current and two previous releases.<br /> * Determine a go-public date for announcing the vulnerability and the fix. To try to mitigate a possible &quot;arms race&quot; between those applying the patch and those trying to exploit the hole, we will not announce security problems immediately.<br /> * Publicly announce the vulnerability and the fix on the pre-determined go-public date. This will probably mean a new release of Joomla! but in some cases it may simply be patches against current releases.</div>

Jinx http://docs.joomla.org/Filing_bugs_and_issues 2008-01-21T12:27:57Z

<p>Jinx: </p> <hr /> <div>{{review}}<br /> <br /> == Reporting bugs ==<br /> <br /> To report a bug in the Joomla! bug trackers, one has to create an &quot;artefact&quot;. Once this artefact is created, the developers will check the validity of it and act accordingly.<br /> <br /> === Register an Account at joomlacode.org ===<br /> [http://joomlacode.org/gf/account/?action=UserAdd Register]<br /> <br /> === Access the joomla! development bug tracker. ===<br /> <br /> *[http://joomlacode.org/gf/project/joomla/tracker/?action=TrackerItemBrowse&amp;tracker_id=32 Joomla! 1.5 Bug Tracker]<br /> *[http://joomlacode.org/gf/project/joomla/tracker/?action=TrackerItemBrowse&amp;tracker_id=5782 Joomla! 1.0 Bug Tracker]<br /> <br /> === Check to see if the bug you want to report is already reported. ===<br /> <br /> A series of filters display the artifacts. Make sure Priority is set to &quot;Any&quot;, Assignee to &quot;Any&quot; and Status to &quot;Any&quot;, other filters to nothing. Mouse over the title of the artefacts to check their contents. If the issue you are experiencing is not already reported, click on the bottom-right Button &quot;Add new Tracker Item&quot;.<br /> <br /> A new screen will display and there, the more information you give, the easier it is for the developers.<br /> <br /> Fill as many fields as you can.<br /> <br /> * Priority : Use the default &quot;Medium&quot; except if you know the code enough to make another choice.<br /> * PHP : Choose the version you are testing on. You can find this information by clicking the Menu &quot;Help&quot;-&gt;&quot;System Info&quot; in the Administrator back-end of Joomla!<br /> * Estimated Time : Leave this blank.<br /> * Build : Type here the #SVN number if you know it, or Nightly Build date, or Version used if using a Released version.<br /> * Browser : Self-explanatory.<br /> * Database : The version of MySQL is also available in &quot;Help&quot; -&gt; &quot;System Info&quot;.<br /> * Status : Leave this to &quot;Open&quot;.<br /> * Percent Complete : Leave this blank.<br /> * Category : This one is more tricky. Use &quot;Administration&quot; if you do not know better.<br /> * Customer : Use &quot;User&quot; if the issue is in front-end, &quot;Developer&quot; if the issue concerns an extension you are developing, &quot;Administrator&quot; in other cases.<br /> * Web Server : The version/server type is also available in &quot;Help&quot; -&gt; &quot;System Info&quot;.<br /> <br /> === Provide a summary ===<br /> <br /> Describe in a few words the issues you are having. It is generally a good idea to use existing artefacts as examples if this is your first time reporting a bug.<br /> <br /> Examples:<br /> <br /> * Front-end: Warning such and such.<br /> * Back-end: Unable to save article when &quot;nameofplugin&quot; is published.<br /> <br /> Note: Take care to be descriptive in your summary as this is the first thing the developers will see when they are perusing the tracker for something to fix.<br /> <br /> <br /> === Provide details about the bug ===<br /> <br /> This is the most important part of reporting the bug. Describe here step by step how you got the error you are noticing.<br /> <br /> The more details, the better.<br /> <br /> Examples:<br /> <br /> A. When I enabled &quot;nameofplugin&quot;, no article can be saved. These are the plugins enabled at the same time. SEF is on (or Off). My site is in a sub-folder. I also remark that... etc. Files such and such are the issues IMHO (if you know what you are talking about).<br /> <br /> B. Back-end. Clicking on &quot;menu_name&quot; Menu. Page opened is blank. Any other menu works OK. etc.<br /> <br /> C. Back-end. Content -&gt; Article Manager (The -&gt; means you click on a submenu). Editing a non-categorized Article. Section dropdown does not display the sections available (or Editor is going over the right column for parameters, or Can't save article after changing a parameter [describe parameter], etc.<br /> <br /> D. I have such an such issue when doing this and that. By changing this code [code proposed] in file [name and hierarchy of file], line(s) #, the issue looks solved on my settings.<br /> <br /> == Add an attachement to your report ===<br /> <br /> To better describe the issue or/and propose a fix, you can add attachments to the artefact you are creating by using the &quot;Browse&quot; buttons at the bottom of the screen.<br /> A screen capture of the page(s) concerned helps a lot. If you can, try to optimise the size of the image through an image editor.<br /> If you know what part(s) of the code base to change, a patch [patches] or a full file where your changes are WELL shown will help the developers to solve the problem quicker.<br /> <br /> === Finish and send in the report ===<br /> <br /> You will receive an e-mail confirming that you posted the artefact. When someone comments or asks for supplementary details or solves the issue, you will receive a notification e-mail and may reply if needed.<br /> <br /> === Extra tips and tricks ===<br /> <br /> Well-written bug reports are incredibly helpful. However, there's a certain amount of overhead involved in working with any bug tracking system, so your help in keeping our ticket tracker as useful as possible is appreciated. In particular:<br /> <br /> * Do read the [http://docs.joomla.org/FAQs FAQ] to see if your issue might be a well-known question.<br /> * Do search [http://joomlacode.org/gf/project/joomla/tracker/ the tracker] to see if your issue has already been filed.<br /> * Do ask on [http://forum.joomla.org/index.php/board,199.0.html testing forums] first if you're not sure if what you're seeing is a bug.<br /> * Do write complete, reproducible, specific bug reports. Include as much information as you possibly can, complete with code snippets, test cases, etc. A minimal example that illustrates the bug in a nice small test case is the best possible bug report.<br /> * Don't use the tracker system to ask support questions. Use the [http://forum.joomla.org/ joomla forums], or the [irc://irc.freenode.net/joomla #joomla] IRC channel on freenode for that.<br /> * Don't use the trackers to make large-scale feature requests. We like to discuss any big changes to Joomla's core on the [http://forum.joomla.org/index.php#6 developers forums] before actually working on them.<br /> * Don't reopen issues that have been marked &quot;not a bug&quot;. This mark means that the decision has been made that we can't or won't fix this particular issue. If you're not sure why, please ask on developer forums.<br /> * Don't use the tracker for lengthy discussions, because they're likely to get lost. If a particular artifcact is controversial, please move discussion to [http://forum.joomla.org/index.php#6 developer forums].<br /> <br /> == Reporting security issues ==<br /> <br /> Report security issues to security [at] joomla [dot] org. This is a private list only open to long-time, highly trusted Joomla developers, and its archives are not publicly readable.<br /> <br /> In the event of a confirmed vulnerability in Joomla itself, we will take the following actions:<br /> <br /> * Acknowledge to the reporter that we've received the report and that a fix is forthcoming. We'll give a rough timeline and ask the reporter to keep the issue confidential until we announce it.<br /> * Halt all other development as long as is needed to develop a fix, including patches against the current and two previous releases.<br /> * Determine a go-public date for announcing the vulnerability and the fix. To try to mitigate a possible &quot;arms race&quot; between those applying the patch and those trying to exploit the hole, we will not announce security problems immediately.<br /> * Publicly announce the vulnerability and the fix on the pre-determined go-public date. This will probably mean a new release of Joomla! but in some cases it may simply be patches against current releases.</div>

Jinx http://docs.joomla.org/Filing_bugs_and_issues 2008-01-21T12:27:26Z

<p>Jinx: </p> <hr /> <div>{{review}}<br /> <br /> == Reporting bugs ==<br /> <br /> To report a bug in the Joomla! bug trackers, one has to create an &quot;artefact&quot;. Once this artefact is created, the developers will check the validity of it and act accordingly.<br /> <br /> === Register an Account at joomlacode.org ===<br /> [http://joomlacode.org/gf/account/?action=UserAdd Register]<br /> <br /> === Access the joomla! development bug tracker. ===<br /> <br /> *[http://joomlacode.org/gf/project/joomla/tracker/?action=TrackerItemBrowse&amp;tracker_id=32 Joomla! 1.5 Bug Tracker]<br /> *[http://joomlacode.org/gf/project/joomla/tracker/?action=TrackerItemBrowse&amp;tracker_id=5782 Joomla! 1.0 Bug Tracker]<br /> <br /> === Check to see if the bug you want to report is already reported. ===<br /> <br /> A series of filters display the artifacts. Make sure Priority is set to &quot;Any&quot;, Assignee to &quot;Any&quot; and Status to &quot;Any&quot;, other filters to nothing. Mouse over the title of the artefacts to check their contents. If the issue you are experiencing is not already reported, click on the bottom-right Button &quot;Add new Tracker Item&quot;.<br /> <br /> A new screen will display and there, the more information you give, the easier it is for the developers.<br /> <br /> Fill as many fields as you can.<br /> <br /> * Priority : Use the default &quot;Medium&quot; except if you know the code enough to make another choice.<br /> * PHP : Choose the version you are testing on. You can find this information by clicking the Menu &quot;Help&quot;-&gt;&quot;System Info&quot; in the Administrator back-end of Joomla!<br /> * Estimated Time : Leave this blank.<br /> * Build : Type here the #SVN number if you know it, or Nightly Build date, or Version used if using a Released version.<br /> * Browser : Self-explanatory.<br /> * Database : The version of MySQL is also available in &quot;Help&quot; -&gt; &quot;System Info&quot;.<br /> * Status : Leave this to &quot;Open&quot;.<br /> * Percent Complete : Leave this blank.<br /> * Category : This one is more tricky. Use &quot;Administration&quot; if you do not know better.<br /> * Customer : Use &quot;User&quot; if the issue is in front-end, &quot;Developer&quot; if the issue concerns an extension you are developing, &quot;Administrator&quot; in other cases.<br /> * Web Server : The version/server type is also available in &quot;Help&quot; -&gt; &quot;System Info&quot;.<br /> <br /> === Provide a summary ===<br /> <br /> Describe in a few words the issues you are having. It is generally a good idea to use existing artefacts as examples if this is your first time reporting a bug.<br /> <br /> Examples:<br /> <br /> Front-end: Warning such and such.<br /> <br /> or<br /> <br /> Back-end: Unable to save article when &quot;nameofplugin&quot; is published.<br /> <br /> Note: Take care to be descriptive in your summary as this is the first thing the developers will see when they are perusing the tracker for something to fix.<br /> <br /> <br /> === Provide details about the bug ===<br /> <br /> This is the most important part of reporting the bug. Describe here step by step how you got the error you are noticing.<br /> <br /> The more details, the better.<br /> <br /> Examples:<br /> <br /> A. When I enabled &quot;nameofplugin&quot;, no article can be saved. These are the plugins enabled at the same time. SEF is on (or Off). My site is in a sub-folder. I also remark that... etc. Files such and such are the issues IMHO (if you know what you are talking about).<br /> <br /> B. Back-end. Clicking on &quot;menu_name&quot; Menu. Page opened is blank. Any other menu works OK. etc.<br /> <br /> C. Back-end. Content -&gt; Article Manager (The -&gt; means you click on a submenu). Editing a non-categorized Article. Section dropdown does not display the sections available (or Editor is going over the right column for parameters, or Can't save article after changing a parameter [describe parameter], etc.<br /> <br /> D. I have such an such issue when doing this and that. By changing this code [code proposed] in file [name and hierarchy of file], line(s) #, the issue looks solved on my settings.<br /> <br /> == Add an attachement to your report ===<br /> <br /> To better describe the issue or/and propose a fix, you can add attachments to the artefact you are creating by using the &quot;Browse&quot; buttons at the bottom of the screen.<br /> A screen capture of the page(s) concerned helps a lot. If you can, try to optimise the size of the image through an image editor.<br /> If you know what part(s) of the code base to change, a patch [patches] or a full file where your changes are WELL shown will help the developers to solve the problem quicker.<br /> <br /> === Finish and send in the report ===<br /> <br /> You will receive an e-mail confirming that you posted the artefact. When someone comments or asks for supplementary details or solves the issue, you will receive a notification e-mail and may reply if needed.<br /> <br /> === Extra tips and tricks ===<br /> <br /> Well-written bug reports are incredibly helpful. However, there's a certain amount of overhead involved in working with any bug tracking system, so your help in keeping our ticket tracker as useful as possible is appreciated. In particular:<br /> <br /> * Do read the [http://docs.joomla.org/FAQs FAQ] to see if your issue might be a well-known question.<br /> * Do search [http://joomlacode.org/gf/project/joomla/tracker/ the tracker] to see if your issue has already been filed.<br /> * Do ask on [http://forum.joomla.org/index.php/board,199.0.html testing forums] first if you're not sure if what you're seeing is a bug.<br /> * Do write complete, reproducible, specific bug reports. Include as much information as you possibly can, complete with code snippets, test cases, etc. A minimal example that illustrates the bug in a nice small test case is the best possible bug report.<br /> * Don't use the tracker system to ask support questions. Use the [http://forum.joomla.org/ joomla forums], or the [irc://irc.freenode.net/joomla #joomla] IRC channel on freenode for that.<br /> * Don't use the trackers to make large-scale feature requests. We like to discuss any big changes to Joomla's core on the [http://forum.joomla.org/index.php#6 developers forums] before actually working on them.<br /> * Don't reopen issues that have been marked &quot;not a bug&quot;. This mark means that the decision has been made that we can't or won't fix this particular issue. If you're not sure why, please ask on developer forums.<br /> * Don't use the tracker for lengthy discussions, because they're likely to get lost. If a particular artifcact is controversial, please move discussion to [http://forum.joomla.org/index.php#6 developer forums].<br /> <br /> == Reporting security issues ==<br /> <br /> Report security issues to security [at] joomla [dot] org. This is a private list only open to long-time, highly trusted Joomla developers, and its archives are not publicly readable.<br /> <br /> In the event of a confirmed vulnerability in Joomla itself, we will take the following actions:<br /> <br /> * Acknowledge to the reporter that we've received the report and that a fix is forthcoming. We'll give a rough timeline and ask the reporter to keep the issue confidential until we announce it.<br /> * Halt all other development as long as is needed to develop a fix, including patches against the current and two previous releases.<br /> * Determine a go-public date for announcing the vulnerability and the fix. To try to mitigate a possible &quot;arms race&quot; between those applying the patch and those trying to exploit the hole, we will not announce security problems immediately.<br /> * Publicly announce the vulnerability and the fix on the pre-determined go-public date. This will probably mean a new release of Joomla! but in some cases it may simply be patches against current releases.</div>

Jinx http://docs.joomla.org/Filing_bugs_and_issues 2008-01-21T11:46:19Z

<p>Jinx: </p> <hr /> <div>{{review}}<br /> <br /> === Reporting bugs ===<br /> <br /> Well-written bug reports are incredibly helpful. However, there's a certain amount of overhead involved in working with any bug tracking system, so your help in keeping our ticket tracker as useful as possible is appreciated. In particular:<br /> <br /> * Do read the [http://docs.joomla.org/FAQs FAQ] to see if your issue might be a well-known question.<br /> * Do search [http://joomlacode.org/gf/project/joomla/tracker/ the tracker] to see if your issue has already been filed.<br /> * Do ask on [http://forum.joomla.org/index.php/board,199.0.html testing forums] first if you're not sure if what you're seeing is a bug.<br /> * Do write complete, reproducible, specific bug reports. Include as much information as you possibly can, complete with code snippets, test cases, etc. A minimal example that illustrates the bug in a nice small test case is the best possible bug report.<br /> * Don't use the tracker system to ask support questions. Use the [http://forum.joomla.org/ joomla forums], or the [irc://irc.freenode.net/joomla #joomla] IRC channel on freenode for that.<br /> * Don't use the trackers to make large-scale feature requests. We like to discuss any big changes to Joomla's core on the [http://forum.joomla.org/index.php#6 developers forums] before actually working on them.<br /> * Don't reopen issues that have been marked &quot;not a bug&quot;. This mark means that the decision has been made that we can't or won't fix this particular issue. If you're not sure why, please ask on developer forums.<br /> * Don't use the tracker for lengthy discussions, because they're likely to get lost. If a particular artifcact is controversial, please move discussion to [http://forum.joomla.org/index.php#6 developer forums].<br /> <br /> === Reporting security issues ===<br /> <br /> Report security issues to security [at] joomla [dot] org. This is a private list only open to long-time, highly trusted Joomla developers, and its archives are not publicly readable.<br /> <br /> In the event of a confirmed vulnerability in Joomla itself, we will take the following actions:<br /> <br /> * Acknowledge to the reporter that we've received the report and that a fix is forthcoming. We'll give a rough timeline and ask the reporter to keep the issue confidential until we announce it.<br /> * Halt all other development as long as is needed to develop a fix, including patches against the current and two previous releases.<br /> * Determine a go-public date for announcing the vulnerability and the fix. To try to mitigate a possible &quot;arms race&quot; between those applying the patch and those trying to exploit the hole, we will not announce security problems immediately.<br /> * Publicly announce the vulnerability and the fix on the pre-determined go-public date. This will probably mean a new release of Joomla! but in some cases it may simply be patches against current releases.</div>

Jinx http://docs.joomla.org/Filing_bugs_and_issues 2008-01-21T11:39:24Z

<p>Jinx: </p> <hr /> <div>=== Reporting bugs ===<br /> <br /> Well-written bug reports are incredibly helpful. However, there's a certain amount of overhead involved in working with any bug tracking system, so your help in keeping our ticket tracker as useful as possible is appreciated. In particular:<br /> <br /> * Do read the FAQ to see if your issue might be a well-known question.<br /> * Do search the tracker to see if your issue has already been filed.<br /> * Do ask on testing forums first if you're not sure if what you're seeing is a bug.<br /> * Do write complete, reproducible, specific bug reports. Include as much information as you possibly can, complete with code snippets, test cases, etc. A minimal example that illustrates the bug in a nice small test case is the best possible bug report.<br /> * Don't use the tracker system to ask support questions. Use the joomla forums, or the #joomla IRC channel on freenode for that.<br /> * Don't use the trackers to make large-scale feature requests. We like to discuss any big changes to Joomla's core on the developers forums before actually working on them.<br /> * Don't reopen issues that have been marked &quot;not a bug&quot;. This mark means that the decision has been made that we can't or won't fix this particular issue. If you're not sure why, please ask on developer forums.<br /> * Don't use the tracker for lengthy discussions, because they're likely to get lost. If a particular artifcact is controversial, please move discussion to developer forums.<br /> <br /> === Reporting security issues ===<br /> <br /> Report security issues to security [at] joomla [dot] org. This is a private list only open to long-time, highly trusted Joomla developers, and its archives are not publicly readable.<br /> <br /> In the event of a confirmed vulnerability in Joomla itself, we will take the following actions:<br /> <br /> * Acknowledge to the reporter that we've received the report and that a fix is forthcoming. We'll give a rough timeline and ask the reporter to keep the issue confidential until we announce it.<br /> * Halt all other development as long as is needed to develop a fix, including patches against the current and two previous releases.<br /> * Determine a go-public date for announcing the vulnerability and the fix. To try to mitigate a possible &quot;arms race&quot; between those applying the patch and those trying to exploit the hole, we will not announce security problems immediately.<br /> * Publicly announce the vulnerability and the fix on the pre-determined go-public date. This will probably mean a new release of Joomla! but in some cases it may simply be patches against current releases.</div>

Jinx http://docs.joomla.org/Filing_bugs_and_issues 2008-01-21T11:39:06Z

<p>Jinx: New page: = Reporting bugs = Well-written bug reports are incredibly helpful. However, there's a certain amount of overhead involved in working with any bug tracking system, so your help in keeping...</p> <hr /> <div>= Reporting bugs =<br /> <br /> Well-written bug reports are incredibly helpful. However, there's a certain amount of overhead involved in working with any bug tracking system, so your help in keeping our ticket tracker as useful as possible is appreciated. In particular:<br /> <br /> * Do read the FAQ to see if your issue might be a well-known question.<br /> * Do search the tracker to see if your issue has already been filed.<br /> * Do ask on testing forums first if you're not sure if what you're seeing is a bug.<br /> * Do write complete, reproducible, specific bug reports. Include as much information as you possibly can, complete with code snippets, test cases, etc. A minimal example that illustrates the bug in a nice small test case is the best possible bug report.<br /> * Don't use the tracker system to ask support questions. Use the joomla forums, or the #joomla IRC channel on freenode for that.<br /> * Don't use the trackers to make large-scale feature requests. We like to discuss any big changes to Joomla's core on the developers forums before actually working on them.<br /> * Don't reopen issues that have been marked &quot;not a bug&quot;. This mark means that the decision has been made that we can't or won't fix this particular issue. If you're not sure why, please ask on developer forums.<br /> * Don't use the tracker for lengthy discussions, because they're likely to get lost. If a particular artifcact is controversial, please move discussion to developer forums.<br /> <br /> = Reporting security issues =<br /> <br /> Report security issues to security [at] joomla [dot] org. This is a private list only open to long-time, highly trusted Joomla developers, and its archives are not publicly readable.<br /> <br /> In the event of a confirmed vulnerability in Joomla itself, we will take the following actions:<br /> <br /> * Acknowledge to the reporter that we've received the report and that a fix is forthcoming. We'll give a rough timeline and ask the reporter to keep the issue confidential until we announce it.<br /> * Halt all other development as long as is needed to develop a fix, including patches against the current and two previous releases.<br /> * Determine a go-public date for announcing the vulnerability and the fix. To try to mitigate a possible &quot;arms race&quot; between those applying the patch and those trying to exploit the hole, we will not announce security problems immediately.<br /> * Publicly announce the vulnerability and the fix on the pre-determined go-public date. This will probably mean a new release of Joomla! but in some cases it may simply be patches against current releases.</div>

Jinx http://docs.joomla.org/Patch_submission_guidelines 2008-01-21T11:36:22Z

<p>Jinx: New page: {{review}} We're always grateful for patches to Joomla's code. Indeed, bug reports with associated patches will get fixed far more quickly than those without patches. '''Patch style''' ...</p> <hr /> <div>{{review}}<br /> <br /> We're always grateful for patches to Joomla's code. Indeed, bug reports with associated patches will get fixed far more quickly than those without patches.<br /> <br /> '''Patch style'''<br /> <br /> * Make sure your code matches our coding style.<br /> * Submit patches in the format returned by the svn diff command. An exception is for code changes that are described more clearly in plain English than in code. Indentation is the most common example; it's hard to read patches when the only difference in code is that it's indented.<br /> * Attach patches to a artefact in the trackers, using the &quot;attach file&quot; button. Please don't put the patch in the artefact description or comment unless it's a single line patch.<br /> * Name the patch file with a .diff extension<br /> * Put the prefix &quot;[patch] &quot; before the title of your artefact. This will make it obvious that the artefact includes a patch.</div>

Jinx http://docs.joomla.org/Participating_in_the_community 2008-01-21T11:31:40Z

<p>Jinx: </p> <hr /> <div>{{review}}<br /> <br /> If you think working with Joomla! is fun, wait until you start working on it. We're passionate about helping Joomla! users make the jump to becoming contributing members of the community, so there are many ways you can help Joomla's development:<br /> <br /> * Submit news about Joomla!. We syndicate all Joomla! related news on our [http://www.joomla.org/content/blogcategory/0/33/ news portal]. If you have some Joomla! news that you would like to share with the community, please submit your short story, article, announcement or review here.<br /> * Report bugs and request features in our [http://joomlacode.org/gf/project/joomla/tracker/ trackers]. Please read Reporting bugs, below, for details on how we like our bug reports served up<br /> * Submit patches for new and/or fixed behavior. Please read Submitting patches, below, for details on how to submit a patch.<br /> * Join the [http://forum.joomla.org/index.php#6 developer forums] and share your ideas for how to improve Joomla!. We're always open to suggestions, although we're likely to be skeptical of large-scale suggestions without some code to back it up.<br /> * Join any of the [http://dev.joomla.org/content/view/13/53/ community working groups] and bring your personal expertise to the Joomla! community. More info about the different working groups can be found here.<br /> <br /> That's all you need to know if you'd like to join the Joomla! development community.</div>

Jinx http://docs.joomla.org/Participating_in_the_community 2008-01-21T11:31:10Z

<p>Jinx: </p> <hr /> <div>{{review}}<br /> <br /> If you think working with Joomla! is fun, wait until you start working on it. We're passionate about helping Joomla! users make the jump to becoming contributing members of the community, so there are many ways you can help Joomla's development:<br /> <br /> * Submit news about Joomla!. We syndicate all Joomla! related news on our [http://www.joomla.org/content/blogcategory/0/33/ news portal]. If you have some Joomla! news that you would like to share with the community, please submit your short story, article, announcement or review here.<br /> * Report bugs and request features in our [http://joomlacode.org/gf/project/joomla/tracker/ trackers]. Please read Reporting bugs, below, for details on how we like our bug reports served up<br /> * Submit patches for new and/or fixed behavior. Please read Submitting patches, below, for details on how to submit a patch.<br /> * Join the [http://forum.joomla.org/index.php#6 developer forums] and share your ideas for how to improve Joomla!. We're always open to suggestions, although we're likely to be skeptical of large-scale suggestions without some code to back it up.<br /> * Join any of the [http://dev.joomla.org/content/view/13/53/ community working groups] and bring your personal expertise to the Joomla! community. More info about the different working groups can be found here.<br /> <br /> That's all you need to know if you'd like to join the Joomla! development community. The rest of this document describes the details of how our community works and how it handles bugs, mailing lists, and all the other minutiae of Joomla! development.</div>

Jinx http://docs.joomla.org/Participating_in_the_community 2008-01-21T11:28:40Z

<p>Jinx: </p> <hr /> <div>{{underconstruction}}<br /> <br /> If you think working with Joomla! is fun, wait until you start working on it. We're passionate about helping Joomla! users make the jump to becoming contributing members of the community, so there are many ways you can help Joomla's development:<br /> <br /> * Submit news about Joomla!. We syndicate all Joomla! related news on our [http://www.joomla.org/content/blogcategory/0/33/ news portal]. If you have some Joomla! news that you would like to share with the community, please submit your short story, article, announcement or review here.<br /> * Report bugs and request features in our [http://joomlacode.org/gf/project/joomla/tracker/ trackers]. Please read Reporting bugs, below, for details on how we like our bug reports served up<br /> * Submit patches for new and/or fixed behavior. Please read Submitting patches, below, for details on how to submit a patch.<br /> * Join the [http://forum.joomla.org/index.php#6 developer forums] and share your ideas for how to improve Joomla!. We're always open to suggestions, although we're likely to be skeptical of large-scale suggestions without some code to back it up.<br /> * Join any of the [http://dev.joomla.org/content/view/13/53/ community working groups] and bring your personal expertise to the Joomla! community. More info about the different working groups can be found here.<br /> <br /> That's all you need to know if you'd like to join the Joomla! development community. The rest of this document describes the details of how our community works and how it handles bugs, mailing lists, and all the other minutiae of Joomla! development.</div>

Jinx http://docs.joomla.org/Participating_in_the_community 2008-01-21T11:28:20Z

<p>Jinx: </p> <hr /> <div>{{inuse}}<br /> <br /> If you think working with Joomla! is fun, wait until you start working on it. We're passionate about helping Joomla! users make the jump to becoming contributing members of the community, so there are many ways you can help Joomla's development:<br /> <br /> * Submit news about Joomla!. We syndicate all Joomla! related news on our [http://www.joomla.org/content/blogcategory/0/33/ news portal]. If you have some Joomla! news that you would like to share with the community, please submit your short story, article, announcement or review here.<br /> * Report bugs and request features in our [http://joomlacode.org/gf/project/joomla/tracker/ trackers]. Please read Reporting bugs, below, for details on how we like our bug reports served up<br /> * Submit patches for new and/or fixed behavior. Please read Submitting patches, below, for details on how to submit a patch.<br /> * Join the [http://forum.joomla.org/index.php#6 developer forums] and share your ideas for how to improve Joomla!. We're always open to suggestions, although we're likely to be skeptical of large-scale suggestions without some code to back it up.<br /> * Join any of the [http://dev.joomla.org/content/view/13/53/ community working groups] and bring your personal expertise to the Joomla! community. More info about the different working groups can be found here.<br /> <br /> That's all you need to know if you'd like to join the Joomla! development community. The rest of this document describes the details of how our community works and how it handles bugs, mailing lists, and all the other minutiae of Joomla! development.</div>

Jinx http://docs.joomla.org/Participating_in_the_community 2008-01-21T11:17:44Z

<p>Jinx: New page: {{inuse}}</p> <hr /> <div>{{inuse}}</div>

Jinx http://docs.joomla.org/JDOC:Joomla!_Doc_Camp/Start_Here 2008-01-21T11:17:29Z

<p>Jinx: /* Audience: Core Developers */</p> <hr /> <div>__NOTOC__<br /> {| cellspacing=&quot;0&quot; cellpadding=&quot;0&quot; style=&quot;margin:0em 0em 1em 0em; width:100%&quot;<br /> | style=&quot;width:50%; vertical-align:top; border:1px solid Gold; background-color: LightYellow;&quot; rowspan=&quot;1&quot;|<br /> &lt;div style=&quot;border-bottom:1px solid Gold; background-color:#ffffaa; padding:0.2em 0.5em 0.2em 0.5em; font-size:110%; font-weight:bold;&quot;&gt;Instructions&lt;/div&gt;<br /> &lt;div style=&quot;padding:0.4em 1em 0.3em 1em;&quot;&gt;<br /> 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.<br /> <br /> 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 &quot;text&quot; into a link, change it to &lt;nowiki&gt;&quot;[[text]]&quot;&lt;/nowiki&gt;. 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].<br /> <br /> '''When you begin editing a page please add &lt;nowiki&gt;{{inuse}}&lt;/nowiki&gt; 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.'''<br /> &lt;/div&gt;<br /> <br /> | style=&quot;padding:0em 0.5em 0em 0.5em;&quot; |<br /> <br /> | colspan=&quot;1&quot; style=&quot;width:50%; vertical-align:top; border:1px solid #abd5f5; background-color:#f1f5fc;&quot; |<br /> &lt;div style=&quot;border-bottom:1px solid #abd5f5; background-color:#d0e5f5; padding:0.2em 0.5em 0.2em 0.5em; font-size:110%; font-weight:bold;&quot;&gt;Reference Information&lt;/div&gt;<br /> &lt;div style=&quot;padding:1em 1em 1em 1em;&quot;&gt; &lt;!--Note: Top, right, bottom, left --&gt;<br /> * 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.<br /> * List of '''[[local wiki templates]]''' that can be used in your wiki pages. Templates reduce repetition and are the basis of modular documentation.<br /> * 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.<br /> * 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 [http://php.net/manual PHP documentation] or [[wikipedia:Main_Page|Wikipedia]].<br /> * Please read the '''[http://help.joomla.org/workshop/documents/Editorial%20Style%20Guide%20v1.0.5.pdf Joomla! Editorial Style Guide]'''.<br /> &lt;/div&gt;<br /> |}<br /> <br /> ==Doc Camp Cookie Jar==<br /> 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.<br /> * [[Joomla!]] - basic introduction to what Joomla! is, why you might want to download it, and where to go to get more information.<br /> * [[Copying a Joomla website]]<br /> * [[Using an FTP client to upload files]]<br /> * [[Using a terminal session]]<br /> * [[Migrating from 1.0.x to 1.5 Stable]] - see [http://dev.joomla.org/component/option,com_jd-wiki/Itemid,/id,migration:migration-component/]<br /> <br /> We need some basic information on the following pages. Looking for a simple definition of the term with links to further information if required.<br /> * [[ACL]] (redirect to [[Access Control List]])<br /> * [[Access Control List]]<br /> * [[Admin]] (redirect to Administrator)<br /> * [[Administrator]]<br /> * [[Backup]]<br /> * [[Banner]]<br /> * [[Blog]]<br /> * [[Calendar]]<br /> * [[Configuration]] (redirect to [[Screen.config.15|Screen.config.15]])<br /> * [[CSS]]<br /> * [[Database]]<br /> * [[Events]]<br /> * [[Front page]]<br /> * [[Global configuration]] (redirect to [[Screen.config.15|Screen.config.15]])<br /> * [[Installer]]<br /> * [[Languages]]<br /> * [[LDAP]] as in Lightweight Directory Access Protocol<br /> * [[Module positions]]<br /> * [[PHP]]<br /> * [[Register globals]]<br /> * [[Requirements]]<br /> * [[Release]]<br /> * [[Restricted access]]<br /> * [[Screen Captures]]<br /> * [[Search]]<br /> * [[Security]]<br /> * [[session save path]]<br /> * [[Setup]]<br /> <br /> ==Audience: Users/Administrators==<br /> 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.<br /> <br /> * [[Installation notes for specific platforms]]<br /> * [[Help screens]].<br /> * [[Marketing Information]] such as features and benefits.<br /> * Create one or more demo/showcase sites then create tutorials explaining how each was put together. For inspiration see: [http://www.adobe.com/devnet/blueprint/]<br /> * [[Beginners|Absolute Beginners Guide to Joomla!]]<br /> * [[Beginners_(Concise) | Another Absolute Beginners Guide to Joomla!]]<br /> * [[Landing Pages]] for this wiki.<br /> * [[FAQs]] Frequently Asked Questions<br /> <br /> ==Audience: Web Designers==<br /> 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.<br /> <br /> * [[Accessibility]]<br /> * [[Beez]] - an accessible default template<br /> * [[Creating clickable background images using CSS]].<br /> * 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]].<br /> * [[jdoc statements]] for templates<br /> * Modify the [[favicon]]<br /> <br /> ==Audience: Core Developers==<br /> By &quot;core developers&quot; we mean developers who are contributing to the Joomla! core distribution which includes the core extensions as well as the Framework.<br /> <br /> * Developer guidelines.<br /> * [[Participating in the community]]: a brief description of how people can get involved.<br /> * Coding style and standards.<br /> * Secure coding guidelines.<br /> * Error message conventions.<br /> * Exception handling.<br /> * [[Patch submission guidelines]].<br /> * [[Filing bugs/issues]].<br /> * [[How to release a distribution tarball]].<br /> * Release numbering, compatibility and deprecation.<br /> * Localisation (L18N): an explanation of how localisation is implemented in Joomla! 1.5 and how to use it.<br /> * [[Routing]]: how it works and how to use it<br /> <br /> ==Audience: Third-party Developers==<br /> By &quot;third-party developers&quot; we mean developers who are working on extensions to Joomla! (components, modules, plugins and templates) which are made available separately from the Joomla! distribution.<br /> <br /> * Complete/update/review the wiki API reference (assumes this has been moved from DocuWiki to MediaWiki).<br /> * Update developer tutorials and how-to's currently on dev.joomla.org<br /> ** Review all material under the tutorials heading at http://dev.joomla.org/component/option,com_jd-wiki/Itemid,32/<br /> ** Recommend material to be migrated over to docs.joomla.org<br /> ** Update material that is to be migrated over to docs.joomla.org<br /> * [[How to debug your code]].<br /> ** 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.<br /> * [[Using the core parameter types]]<br /> * [[Creating custom XML parameter types]].<br /> ** 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.<br /> * [[Creating component preferences]] (ready for review).<br /> ** 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.<br /> * [[Adding JavaScript and CSS to the page]].<br /> ** 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.<br /> * [[Accessing the current user object]].<br /> ** 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.<br /> * [[Adding AJAX to your component]].<br /> ** 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).<br /> * [[Using JPagination in your component]] (frontend and backend).<br /> ** Describe the steps necessary to add pagination to a component using the JPagination class. Describe the differences between frontend and backend.<br /> * [[Creating a toolbar for your component]].<br /> * [[Adding configuration objects to modules and plugins]].<br /> * [[Storing data in the session between page loads]].<br /> * [[Using the caching system in your component]].<br /> * [[Creating a file uploader in your component]].<br /> * [[Suppressing output of extra HTML]].<br /> * [[Supporting plugins in your component]].<br /> ** Explain how to add triggers so that your component can fire custom events.<br /> * [[Adding multi-language support]].<br /> * [[Retrieving data from GET and POST requests]] - the Joomla! way.<br /> * [[Adding view layout configuration parameters]].<br /> ** Explain how to create an XML file that will allow users to configure views.<br /> * [[Using the installer API to support package installation]].<br /> ** Explain how to use the JInstaller API to install add-ons to components<br /> * [[How to implement XML-RPC in a component]]<br /> ** There are two ways to do this:<br /> *** Implement it using an XML-RPC plugin<br /> *** Implement it in the component itself using raw views<br /> * [[How to use the filesystem package]]<br /> * [[How to use the filter package]]<br /> ** Describe how and when to use the Filter package and explain what needs to be filtered for various situations (for queries, for URLs, etc)<br /> * [[How to use the registry package]]<br /> * [[How to use JSimpleXML]]<br /> ** How to load and store XML files and how to work with them<br /> * [[How to use JDate]]<br /> ** What JDate does and how to use it...<br /> * [[How to add CSRF anti-spoofing to forms]]<br /> ** How to use JHTML::_( 'form.token' ) and token checking to secure components<br /> * [[How to add breadcrumbs]]<br /> * [[How to use the JTable class]]<br /> * [[How to create component feeds]] (RSS/ATOM)<br /> * [[How to create PDF views]]<br /> * [[How to send email from components]]<br /> * [[What's available in the JFactory class]]<br /> * [[How to generate paths for client side and server side]]<br /> * How to access information from the request/browser<br /> ** This focuses on using the JBrowser class to retrieve information about the features available in the user's browser.<br /> * [[How to create a search plugin]] (To be reviewed)<br /> * [[How to create a content plugin]] (To be reviewed)<br /> * [[How to create an editor plugin]]<br /> * [[How to create a system plugin]]<br /> * [[What can be done with a user plugin]]<br /> * [[How to create a module]]<br /> * [[How to create a stand-alone application using the Joomla! Framework]]<br /> * [[How to work with parameters]]<br /> * [[How to use the JToolBar class in the frontend]]<br /> * [[How to create a custom button]]<br /> * [[How to use the editor in a component]]<br /> * [[How to use the JPane classes in a component]]<br /> * [[How to cloak email addresses]]<br /> <br /> ==Audience: Testers==<br /> These people may be testing functionality from a user perspective; or they may be developers testing the code itself.<br /> <br /> * Automated testing.<br /> <br /> ==Audience: Various==<br /> Stuff that pertains to multiple audiences.<br /> <br /> * [[Joomla! 1.5 Template Tutorials Project]]<br /> * Integrate GHOP student work<br /> * [[:Category:Landing Pages|Landing pages in this wiki]]<br /> * Pages that define terms can be added to the [[:Category:Glossary|Glossary]] category by adding &lt;nowiki&gt;[[Category:Glossary]]&lt;/nowiki&gt; at the end of the page.<br /> <br /> ==Audience: Documentors==<br /> This is meta documentation for use by the Documentation Working Group and other documentors.<br /> <br /> [[Project:MediaWiki setup notes|MediaWiki setup notes]]<br /> <br /> ==License==<br /> {{license}}<br /> <br /> [[Category:DocCamp]]</div>

Jinx http://docs.joomla.org/JDOC:Joomla!_Doc_Camp/Contributors_List 2008-01-21T10:38:09Z

<p>Jinx: /* Contributors */</p> <hr /> <div>If you made a contribution to the documentation held on this site, please feel free to add your name below. Please consider adding your real name in addition to your nickname. You may, optionally, include a link to your website.<br /> &lt;onlyinclude&gt;<br /> == Contributors ==<br /> * Chris Davenport ([[Special:Contributions/Chris_Davenport|contributions]])<br /> * Marieke ([[Special:Contributions/Marieke92|contributions]])<br /> * Justin Kerr ([[Special:Contributions/Pomond|contributions]])<br /> * [http://www.jlleblanc.com Joe LeBlanc] ([[Special:Contributions/Jlleblanc|contributions]])<br /> * [http://web.nostalgie.be Christophe Delire] ([[Special:Contributions/Nostalgie|contributions]])<br /> * [http://www.joomlatools.org Johan Janssens] ([[Special:Contributions/Jinx|contributions]])<br /> &lt;/onlyinclude&gt;<br /> [[Category:DocCamp]]</div>

Jinx http://docs.joomla.org/JDOC:Joomla!_Doc_Camp 2008-01-02T18:03:34Z

<p>Jinx: </p> <hr /> <div>Welcome to the first world-wide Joomla! Doc Camp. Following on from the huge success of the Joomla! 1.5 bug squashing event, please join us for a weekend of authoring at locations around the planet. We have tasks for everyone; coders and non-coders alike. Our aim is to dramatically increase the volume of documentation available for Joomla! 1.5.<br /> <br /> This wiki will be used as the central resource for coordinating efforts and accumulating results from this event. After the event it will become a new central hub for the official Joomla! documentation.<br /> <br /> ==Locations==<br /> * [http://www.rmdstudio.com/rmd-studio-news/join-us-for-the-first-vancouver-doccamp-event.html Vancouver, Canada] 9AM to 6PM local time on 19 January 2008.<br /> * [http://www.joomlatools.org/events.html Brussels, Belgium] 10AM to 7PM (GMT +1) on 21 January 2008<br /> * IRC (#joomladocs @freenode) from 19 to 21 January 2008, all times, all timezones.<br /> <br /> ==Registration==<br /> ====for write access to this wiki====<br /> To get write access to this wiki you will need to [[Special:Userlogin|register here first]]. Please be aware that the registration process requires a valid email address. If you are travelling to one of the physical locations you are advised to ensure that you have registered on this wiki and have a valid login before you travel. You don't need access to your email account after registration.<br /> ====at a physical location====<br /> If you wish to be present at one of the physical locations listed above then you must register in advance as space is limited. Registrations are the responsibility of the individual location organisers and you should click on the appropriate link above for more information.<br /> <br /> ==Requirements==<br /> * All contributions must be made available under the [[JEDL|Joomla! Electronic Documentation License]]. Further information on the JEDL is available in the [[JEDL/FAQ|JEDL Frequently Asked Questions]]<br /> * No advertising or self-promotion will be allowed. This includes backlinks to your website or anyone else's. The one exception is that if you have made a contribution then feel free to add your name and an optional link to your website to the [[Doc Camp Contributors List]]<br /> * All contributions must be in English. Note that the official language of the Joomla! project is British/Australian English.<br /> <br /> ==Guidelines==<br /> * 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.<br /> * Please read the [http://help.joomla.org/workshop/documents/Editorial%20Style%20Guide%20v1.0.5.pdf Joomla! Editorial Style Guide]<br /> * The Geshi syntax-highlighter extension has been installed on this wiki. For PHP code use &lt;nowiki&gt;&lt;source lang=&quot;php&quot;&gt;Your PHP code here&lt;/source&gt;&lt;/nowiki&gt;. Further information can be found [http://www.mediawiki.org/wiki/Extension:SyntaxHighlight_GeSHi here].<br /> <br /> ==Where to go next==<br /> Once you have read the above then please click the link below to begin:<br /> <br /> '''[[Doc Campers Start Here]]'''<br /> <br /> [[Category:DocCamp]]<br /> <br /> ==License==<br /> {{license}}</div>

Jinx