Language Metadata

2009-11-23T07:36:30Z

Akede:

Language Metadata

2009-11-23T07:15:57Z

Akede: New page: The CMS Joomla! supports many different languages in the frontend and backend applications already. Since Joomla! 1.5 the articles also do have a language parameter which allows to identif...

The CMS Joomla! supports many different languages in the frontend and backend applications already. Since Joomla! 1.5 the articles also do have a language parameter which allows to identify the language in which an article is written. However all other information such as section/category descriptions, module content or menu names do not have such a tag. This tag will the improve the possibilities of extensions to sort out language specific content. E.g. a RSS feed extension can present information for different languages or a content list can present the number of articles in one specific language without complex and time intensive database queries over a 'text' type filed.

==Specification & Discussion==
The idea of this change is described and discussed in the following threads:
=Whitepaper:=
* [http://forum.joomla.org/viewtopic.php?f=502&t=276920&start=0|13: Make Joomla! information more language aware]

=Mailing list:=
* [http://groups.google.com/group/joomla-dev-cms/browse_thread/thread/f373aa9481a2b730?hl=en-GB#|1.6 and languages/internationalisation]
* [http://groups.google.com/group/joomla-dev-cms/browse_thread/thread/fceebbb8e4d546e3?hl=en-GB#|Can we implement a "language" parameter/field for other aspects than articles?]

Developers

2009-11-23T07:01:44Z

Akede: /* Localisation */

{{Developer profile}}

A complete contents list of all pages of interest to developers can be found in the [[:Category:Development|development category]].

== Reference Material ==

* [[Framework|Joomla Framework]].
* [http://api.joomla.org API documentation] automatically generated using phpDocumentor.

== Articles and Tutorials ==

=== General ===
* [[Setting up your workstation for Joomla! development]]. A step-by-step guide to installing the Eclipse IDE on your local workstation for Joomla! development.
* [[Setting up your workstation for extension development]] A guide to Joomla Extension development
* [http://community.joomla.org/blogs/community/828-webinar-using-eclipse-for-joomla-development.html Using Eclipse for Joomla! Development] Video webinar demonstrating overview of Eclipse features for Joomla! development
* [[Do not use die to debug]]
* [[How to debug your code]]
* [[Tutorial:Adapting Joomla 1.0 extensions to Joomla 1.5]]
* [[Version 1.6 Developer Notes]] {{JVer|1.6}}
* [[Tutorial:Joomla Beginning Developer Course]]

=== Components ===
====Developing a Model-View-Controller (MVC) Component {{JVer|1.5}}====
* [[Developing a Model-View-Controller Component - Part 1]]
* [[Developing a Model-View-Controller Component - Part 2 - Adding a Model]]
* [[Developing a Model-View-Controller Component - Part 3 - Using the Database]]
* [[Developing a Model-View-Controller Component - Part 4 - Creating an Administrator Interface]]
* [[Developing a Model-View-Controller Component - Part 5 - Basic Backend Framework]]
* [[Developing a Model-View-Controller Component - Part 6 - Adding Backend Actions]]

====Developing a Model-View-Controller (MVC) Component {{JVer|1.6}}====
* [[Developing a Model-View-Controller (MVC) Component for Joomla!1.6|Introduction]]
{{Chunk:Developing a Model-View-Controller (MVC) Component for Joomla!1.6 - Contents}}

====Other component topics====
* [[File Structure and Naming Conventions]]
* [[Component parameters]]
* [[Components:xml installfile]]. An example component XML installation file.
* [[How to use the JPane classes in a component]]
* [[How to use the editor in a component]]
* [[Supporting plugins in your component]]
* [[Tutorial:Adding Javascript moo.fx to your component WIP]]
* [[Creating a toolbar for your component]]
* [[Adding view layout configuration parameters]]
* [[How to implement XML-RPC in a component]]
* [[Using JPagination in your component]]
* [[Adding sortable columns to a table in a component]]
* [[Using multiple models in an MVC component]]
* [[Ajax using MooTools]]

=== Modules ===
* [[Tutorial:Creating a Hello World Module for Joomla 1.5]]
* [[How to create a module]]

=== Plugins ===
* [[Plugin Developer Overview]]
* [[Tutorial:Plugins]]
* [http://developer.joomla.org/tutorials/184-how-to-create-a-joomla-plugin.html How to create a Joomla! Plugin]
* [[How to create a content plugin]]
* [[How to create a search plugin]]
* [[Supporting plugins in your component]]
* [[Tutorial:Creating an Authentication Plugin for Joomla 1.5]]
* [[Tutorial:Using plugins in your own extension]]

=== Templates ===
* [[Understanding Output Overrides]]
* [http://developer.joomla.org/tutorials/165-understanding-output-overrides-in-joomla.html Understanding Output Overrides in Joomla! 1.5]
* [[Creating custom template parameter types]]
* [[How are templates executed?]]
* [[How to determine if the user is viewing the front page]]
* [[Tutorial:Template parameters]]

===Parameters===
* [[Standard parameter types]]
* [[Custom parameter types]]
* [[Component parameters]]
* [[Creating custom template parameter types]]
See also: [[:Category:Parameters]]

=== Security ===
* [[How to add CSRF anti-spoofing to forms]]
* [http://developer.joomla.org/tutorials/181-preventing-sql-injections.html Preventing SQL Injections]
* [[Tutorial:How to make your Joomla addon more secure WIP]]

=== Database ===
* [[How to use the database classes in your script]]
* [[How to use the JTable class]]
* [[How to connect to an external database]]

=== Localisation ===
* [http://community.joomla.org/magazine/article/508-developer-localization-advancements-in-joomla-15.html Localization Advancements in Joomla! 1.5]
* [[Adding multi-language support]]
* [[Adding Joomfish functionality to custom components]]
* [[Specification of language files]] {{JVer|1.6}}
* [[Improving the language awareness]] of Joomla database and core (future versions)

=== Miscellaneous ===
* [[How to use the filesystem package]]
* [[How to use the editor in a component]]
* [[Adding AJAX to your component]].
* [[How to send email from components]]
* [[How to use the JToolBar class in the frontend]]
* [[Routing]]
* [[Joomla Routes and SEF]]
* [[API Execution Order]]
* [[Accessing the current user object]]
* [[Adding JavaScript and CSS to the page]]
* [[Constants]] used in the Joomla [[Framework]].
* [[Form validation]]
* [[How to create a custom button]]
* [[How to create a stand-alone application using the Joomla! Framework]]
* [[How to use user state variables]]
* [[Adding template overridable images in your extension]]
* [[Retrieving data from GET and POST requests]]
* [[Using caching to speed up your code]]
* [[Using a custom image in the menu bar title]]
* [[Using the installer API to support package installation]]
* [[Tutorial:How to add tooltips to your Joomla! website]]
* [[Xml-rpc|XML-RPC]]
* [[How to add breadcrumbs]]
* [[Creating a file uploader in your component]].
* [[Display error messages and notices]].

== Contributing to Joomla Development ==
The development of Joomla itself is carried out by the [[Development Working Group]] and third party developers.

* [[Participating in the community]]: a brief description of how people can get involved.
* [[Developer Email lists]]: a list of email lists for developers, including third party developers.
* [[Coding style and standards]] (To be reviewed).
* [[Setting up your workstation for Joomla! development]]. A step-by-step guide to installing the Eclipse IDE on your local workstation for Joomla! development.
* [http://docs.joomla.org/Setting_up_your_workstation_for_Joomla!_development_--_Part_2#Check_Out_Joomla.21_Source_Code How to check out SVN Code]
* [[Patch submission guidelines]].
* [[Filing bugs and issues]].
* [[How to release a distribution tarball]].

== Contributing to Joomla Developer Documentation ==
The development of Joomla developer documentation is carried out primarily by the [[Documentation Working Group]]. There are currently two sub-projects of interest to developers:
* [[Joomla! 1.5 Template Tutorials Project]]
* [[API Reference Project]]

When creating a new page, ensure you place the following marker at the bottom of the page so it is included in the category list:

<pre><nowiki>[[Category:Development]]
</nowiki></pre>

If you locate other articles you think are relevant to developers, please add this marker to those pages.

=== Suggested topics ===
This is a short list of articles that might be written to support developers. Please feel free to add further topic ideas.

* [[Adding configuration objects to modules and plugins]].
* [[Storing data in the session between page loads]].
* [[Suppressing output of extra HTML]].
* [[How to use the filter package]].
*: Describe how and when to use the Filter package and explain what needs to be filtered for various situations (for queries, for URLs, etc)
* [[How to use the registry package]]
* [[How to use JSimpleXML]].
*: How to load and store XML files and how to work with them
* [[How to create component feeds]] (RSS/ATOM)
* [[How to create PDF views]]
* [[How to generate paths for client side and server side]]
* [[How to access information from the request]]
*: This focuses on using the JBrowser class to retrieve information about the features available in the user's browser.
* [[How to create an editor plugin]]
* [[What can be done with a user plugin]]
* [[How to work with parameters]]
* [[How to cloak email addresses]]
* [[Using the caching system in your component]].

==Joomla Security Guide==
Developers should also be aware of security issues.
{{Security Guide}}
[[Category:Development]]

Creating a language definition file

2009-11-22T19:27:00Z

Akede:

Important note: Joomla language INI files must be saved as UTF-8 without the Byte Order Mark (BOM)<ref name="ftn2">For more information on Byte Order Mark see [http://unicode.org/faq/utf_bom.html#BOM http://unicode.org/faq/utf_bom.html#BOM]</ref>.

The format of language definition files is very basic. Blanks lines and lines beginning with “#” are ignored and the latter may be used to add comments to the file. Each line consists of a pair of strings separated by an equals sign like this

KEY=Value

where “''KEY''” is a string to be translated and “''Value''” is the translated string. For example

ADDITIONAL INFORMATION=Additional Information

The “''KEY''” must be in all capitals or the string will not be found. The case of the source string does not matter as strings are folded to upper case before searching takes place. So “additional information”, “Additional Information” or even “AdDiTiOnAl InFoRmAtIoN” will be matched.

The “''KEY''” can include spaces and other punctuation characters but there should not be any spaces either side of the equals sign as spaces are significant. If more than one entry has the same left-hand side, the last one to be encountered is the one that will be used.

The "''VALUE''" cannot include double-quote characters ("). To get a double-quote character you must use the HTML special character sequence "&quot;" instead. Single-quote characters (') are valid.
<noinclude>
----
<references/>[[Category:Languages]]</noinclude>
More information about the discussed changed for Joomla 1.6 can be found on the page [[Specification of language files]] {{JVer|1.6}}

Developers

2009-11-22T19:24:11Z

Akede: /* Localisation */

{{Developer profile}}

A complete contents list of all pages of interest to developers can be found in the [[:Category:Development|development category]].

== Reference Material ==

* [[Framework|Joomla Framework]].
* [http://api.joomla.org API documentation] automatically generated using phpDocumentor.

== Articles and Tutorials ==

=== General ===
* [[Setting up your workstation for Joomla! development]]. A step-by-step guide to installing the Eclipse IDE on your local workstation for Joomla! development.
* [[Setting up your workstation for extension development]] A guide to Joomla Extension development
* [http://community.joomla.org/blogs/community/828-webinar-using-eclipse-for-joomla-development.html Using Eclipse for Joomla! Development] Video webinar demonstrating overview of Eclipse features for Joomla! development
* [[Do not use die to debug]]
* [[How to debug your code]]
* [[Tutorial:Adapting Joomla 1.0 extensions to Joomla 1.5]]
* [[Version 1.6 Developer Notes]] {{JVer|1.6}}
* [[Tutorial:Joomla Beginning Developer Course]]

=== Components ===
====Developing a Model-View-Controller (MVC) Component {{JVer|1.5}}====
* [[Developing a Model-View-Controller Component - Part 1]]
* [[Developing a Model-View-Controller Component - Part 2 - Adding a Model]]
* [[Developing a Model-View-Controller Component - Part 3 - Using the Database]]
* [[Developing a Model-View-Controller Component - Part 4 - Creating an Administrator Interface]]
* [[Developing a Model-View-Controller Component - Part 5 - Basic Backend Framework]]
* [[Developing a Model-View-Controller Component - Part 6 - Adding Backend Actions]]

====Developing a Model-View-Controller (MVC) Component {{JVer|1.6}}====
* [[Developing a Model-View-Controller (MVC) Component for Joomla!1.6|Introduction]]
{{Chunk:Developing a Model-View-Controller (MVC) Component for Joomla!1.6 - Contents}}

====Other component topics====
* [[File Structure and Naming Conventions]]
* [[Component parameters]]
* [[Components:xml installfile]]. An example component XML installation file.
* [[How to use the JPane classes in a component]]
* [[How to use the editor in a component]]
* [[Supporting plugins in your component]]
* [[Tutorial:Adding Javascript moo.fx to your component WIP]]
* [[Creating a toolbar for your component]]
* [[Adding view layout configuration parameters]]
* [[How to implement XML-RPC in a component]]
* [[Using JPagination in your component]]
* [[Adding sortable columns to a table in a component]]
* [[Using multiple models in an MVC component]]
* [[Ajax using MooTools]]

=== Modules ===
* [[Tutorial:Creating a Hello World Module for Joomla 1.5]]
* [[How to create a module]]

=== Plugins ===
* [[Plugin Developer Overview]]
* [[Tutorial:Plugins]]
* [http://developer.joomla.org/tutorials/184-how-to-create-a-joomla-plugin.html How to create a Joomla! Plugin]
* [[How to create a content plugin]]
* [[How to create a search plugin]]
* [[Supporting plugins in your component]]
* [[Tutorial:Creating an Authentication Plugin for Joomla 1.5]]
* [[Tutorial:Using plugins in your own extension]]

=== Templates ===
* [[Understanding Output Overrides]]
* [http://developer.joomla.org/tutorials/165-understanding-output-overrides-in-joomla.html Understanding Output Overrides in Joomla! 1.5]
* [[Creating custom template parameter types]]
* [[How are templates executed?]]
* [[How to determine if the user is viewing the front page]]
* [[Tutorial:Template parameters]]

===Parameters===
* [[Standard parameter types]]
* [[Custom parameter types]]
* [[Component parameters]]
* [[Creating custom template parameter types]]
See also: [[:Category:Parameters]]

=== Security ===
* [[How to add CSRF anti-spoofing to forms]]
* [http://developer.joomla.org/tutorials/181-preventing-sql-injections.html Preventing SQL Injections]
* [[Tutorial:How to make your Joomla addon more secure WIP]]

=== Database ===
* [[How to use the database classes in your script]]
* [[How to use the JTable class]]
* [[How to connect to an external database]]

=== Localisation ===
* [http://community.joomla.org/magazine/article/508-developer-localization-advancements-in-joomla-15.html Localization Advancements in Joomla! 1.5]
* [[Adding multi-language support]]
* [[Adding Joomfish functionality to custom components]]
* [[Specification of language files]] {{JVer|1.6}}

=== Miscellaneous ===
* [[How to use the filesystem package]]
* [[How to use the editor in a component]]
* [[Adding AJAX to your component]].
* [[How to send email from components]]
* [[How to use the JToolBar class in the frontend]]
* [[Routing]]
* [[Joomla Routes and SEF]]
* [[API Execution Order]]
* [[Accessing the current user object]]
* [[Adding JavaScript and CSS to the page]]
* [[Constants]] used in the Joomla [[Framework]].
* [[Form validation]]
* [[How to create a custom button]]
* [[How to create a stand-alone application using the Joomla! Framework]]
* [[How to use user state variables]]
* [[Adding template overridable images in your extension]]
* [[Retrieving data from GET and POST requests]]
* [[Using caching to speed up your code]]
* [[Using a custom image in the menu bar title]]
* [[Using the installer API to support package installation]]
* [[Tutorial:How to add tooltips to your Joomla! website]]
* [[Xml-rpc|XML-RPC]]
* [[How to add breadcrumbs]]
* [[Creating a file uploader in your component]].
* [[Display error messages and notices]].

== Contributing to Joomla Development ==
The development of Joomla itself is carried out by the [[Development Working Group]] and third party developers.

* [[Participating in the community]]: a brief description of how people can get involved.
* [[Developer Email lists]]: a list of email lists for developers, including third party developers.
* [[Coding style and standards]] (To be reviewed).
* [[Setting up your workstation for Joomla! development]]. A step-by-step guide to installing the Eclipse IDE on your local workstation for Joomla! development.
* [http://docs.joomla.org/Setting_up_your_workstation_for_Joomla!_development_--_Part_2#Check_Out_Joomla.21_Source_Code How to check out SVN Code]
* [[Patch submission guidelines]].
* [[Filing bugs and issues]].
* [[How to release a distribution tarball]].

== Contributing to Joomla Developer Documentation ==
The development of Joomla developer documentation is carried out primarily by the [[Documentation Working Group]]. There are currently two sub-projects of interest to developers:
* [[Joomla! 1.5 Template Tutorials Project]]
* [[API Reference Project]]

When creating a new page, ensure you place the following marker at the bottom of the page so it is included in the category list:

<pre><nowiki>[[Category:Development]]
</nowiki></pre>

If you locate other articles you think are relevant to developers, please add this marker to those pages.

=== Suggested topics ===
This is a short list of articles that might be written to support developers. Please feel free to add further topic ideas.

* [[Adding configuration objects to modules and plugins]].
* [[Storing data in the session between page loads]].
* [[Suppressing output of extra HTML]].
* [[How to use the filter package]].
*: Describe how and when to use the Filter package and explain what needs to be filtered for various situations (for queries, for URLs, etc)
* [[How to use the registry package]]
* [[How to use JSimpleXML]].
*: How to load and store XML files and how to work with them
* [[How to create component feeds]] (RSS/ATOM)
* [[How to create PDF views]]
* [[How to generate paths for client side and server side]]
* [[How to access information from the request]]
*: This focuses on using the JBrowser class to retrieve information about the features available in the user's browser.
* [[How to create an editor plugin]]
* [[What can be done with a user plugin]]
* [[How to work with parameters]]
* [[How to cloak email addresses]]
* [[Using the caching system in your component]].

==Joomla Security Guide==
Developers should also be aware of security issues.
{{Security Guide}}
[[Category:Development]]

1.6: Specification of language files

2009-11-22T19:23:38Z

Akede: 1.6: Specification of language files moved to Specification of language files: Removing the 1.6 tag in the name, added the version info with the new icon

#REDIRECT [[Specification of language files]]

Specification of language files

2009-11-22T19:23:38Z

Akede: 1.6: Specification of language files moved to Specification of language files: Removing the 1.6 tag in the name, added the version info with the new icon

Developers

2009-11-22T19:22:46Z

2008-03-22T09:49:44Z

Akede:

{{Developer profile}}

* Developer guidelines.
* [[Participating in the community]]: a brief description of how people can get involved.
* [[Coding style and standards]].
* Secure coding guidelines.
* Error message conventions.
* Exception handling.
* [[Patch submission guidelines]].
* [[Filing bugs and issues]].
* [[How to release a distribution tarball]].
* Release numbering, compatibility and deprecation.
* [[Localisation]] (L18N): an explanation of how localisation is implemented in Joomla! 1.5 and how to use it.
* [[Routing]]: how it works and how to use it

* Complete/update/review the wiki API reference (assumes this has been moved from DocuWiki to MediaWiki).
* Update developer tutorials and how-to's currently on dev.joomla.org
** Review all material under the tutorials heading at http://dev.joomla.org/component/option,com_jd-wiki/Itemid,32/
** Recommend material to be migrated over to docs.joomla.org
** Update material that is to be migrated over to docs.joomla.org
* [[How to debug your code]].
** 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.
* [[Using the core parameter types]] (To be reviewed)
* [[Creating custom XML parameter types]].
** Write a document detailing the steps to creating a custom XML Parameter type. Explain how these types can be used in templates, modules, components and plugins.
* [[Creating component preferences]] (ready for review).
** Write a document describing how to create an xml file for modifying component preferences and how to add a Parameters button to an administrator toolbar.
* [[Adding JavaScript and CSS to the page]].
** Write a document describing how to add JavaScript and CSS to the page. Explain how to decide whether JavaScript should go in the head block or in the page itself and how to insert the JavaScript.
* [[Accessing the current user object]].
** Write a document describing how to access the current user object and also indicate what type of information can be found in the object, and how that data should be retrieved and/or set.
* [[Adding AJAX to your component]].
** Write a document describing how to add AJAX to an MVC component. If desired, use the MVC Hello World tutorial as a base. Describe where various elements should go in the MVC design pattern. Also describe how to implement MVC in a module (these need supporting components to do AJAX).
* [[Using JPagination in your component]] (frontend and backend).
** Describe the steps necessary to add pagination to a component using the JPagination class. Describe the differences between frontend and backend.
* [[Creating a toolbar for your component]].
* [[Adding configuration objects to modules and plugins]].
* [[Storing data in the session between page loads]].
* [[Using the caching system in your component]].
* [[Creating a file uploader in your component]].
* [[Suppressing output of extra HTML]].
* [[Supporting plugins in your component]].
** Explain how to add triggers so that your component can fire custom events.
* [[Adding multi-language support]].
* [[Retrieving data from GET and POST requests]] - the Joomla! way.
* [[Adding view layout configuration parameters]].
** Explain how to create an XML file that will allow users to configure views.
* [[Using the installer API to support package installation]].
** Explain how to use the JInstaller API to install add-ons to components
* [[How to implement XML-RPC in a component]]
** There are two ways to do this:
*** Implement it using an XML-RPC plugin
*** Implement it in the component itself using raw views
* [[How to use the filesystem package]]
* [[How to use the filter package]]
** Describe how and when to use the Filter package and explain what needs to be filtered for various situations (for queries, for URLs, etc)
* [[How to use the registry package]]
* [[How to use JSimpleXML]]
** How to load and store XML files and how to work with them
* [[How to use JDate]]
** What JDate does and how to use it...
* [[How to add CSRF anti-spoofing to forms]]
** How to use JHTML::_( 'form.token' ) and token checking to secure components
* [[How to add breadcrumbs]]
* [[How to use the JTable class]]
* [[How to create component feeds]] (RSS/ATOM)
* [[How to create PDF views]]
* [[How to send email from components]]
* [[What's available in the JFactory class]]
* [[How to generate paths for client side and server side]]
* How to access information from the request/browser
** This focuses on using the JBrowser class to retrieve information about the features available in the user's browser.
* [[How to create a search plugin]] (To be reviewed)
* [[How to create a content plugin]] (To be reviewed)
* [[How to create an editor plugin]]
* [[How to create a system plugin]]
* [[What can be done with a user plugin]]
* [[How to create a module]]
* [[How to create a stand-alone application using the Joomla! Framework]]
* [[How to work with parameters]]
* [[How to use the JToolBar class in the frontend]]
* [[How to create a custom button]]
* [[How to use the editor in a component]]
* [[How to use the JPane classes in a component]]
* [[How to cloak email addresses]]