|
The Joom!Fish project stores all its work and additional resources at the joomlacode.org repository system. This system provides us with a public accessible system to offer downloads, version control and some additional organizational topics. The project uses joomlacode primarily for the development and translation of the extension language files and help screens. As Joom!Fish is a completely free accessible Open Source project you can access the development trunk as well as all other free accessible resources at anytime using the Subversion system.
Structure of our Subversion repositiory
The primary project location can be accessed via your browser with using the URL: http://joomlacode.org/gf/project/joomfish/scmsvn/. If you browse this URL you will see that we have create two separate repositories:
- development
- documentation
The separation is done primarily to keep the two different kinds of work separated and with that give all the teams the best structure to work with. All directories which are not explicitly mentioned here are outdated and may not include correct information. The whole structure might change without warnings including the deletion of existing files and folders.
Development repository
The development repository includes the standard structure of:
- branches
- stable_releases
- tags
- trunk
- unittests
Within the trunk you find the directory 2.x which is the main development location for the next release. This version includes purely development code and may have bugs, and know issues as well might change quite often in the structure or other things. As this is a development version it is not recommended to use this version on any productive or public accessible server! The trunk includes the package structure as it is used to install Joom!Fish. If you export the directory to a local directory you can pack and install the extension directly using your Joomla installer.
The branches directory is used to implement new features as they are requested on our feedback system. You will find a directory 2.x in there as well which includes special development versions for each of the features. We most like will ask the owner of a feedback request to check out one of these branches in order to verify if we developed his ideas correctly before we merge the work back to the trunk. So if you like to follow a specific feature this is the place to look at.
The stable_releases and tags directory include already published or older version of Joom!Fish which are kept as a copy in order to be able to verify reported issues and bugs. And last but not least the directory unittests includes our specific unit tests which are based on the Joomla unittesting framework.
Documentation
The repository documentation includes our additional files. Here you find in the subdirectories text, configuration and language files in a structure that fits to their specific requirements.
- contentelements
This directory includes the set of core Joom!Fish configuration files as well as additional files we have been provided with. The structure of the folders show you if we e.g. verified the files and know that they are working well together with the latest release of Joom!Fish
- help
This directory includes the help screens and documentation in the various languages. The structure is compatible to the requirements of the Joomla framework.
- ui_translations
This directory includes the extension language files as specified from the Joomla framework. The original files are maintained in the structure of the subfolder en-GB which represents the English originals. Within this folder the structure fits to the requirement of the extension packaging! All other folders hold the most current translations for the respective languages and will be packaged from time to time for a more convenient installation. These files have the required package structure for a working Joomla installation of language files.
How to access the repositories?
The most easy way to access the repositories is using one of the existing SVN clients. After you installed the client it will allow you to either grap a working copy or export a repository to your local computer. In order to do so you need the directory path of the repository you like to have. For example if you like to access the development trunk of Joom!Fish you can use the following path/command.
# path for the development repository incl. anonymous user # replace the user if you have a registered user on joomlacode.org http://
This e-mail address is being protected from spambots. You need JavaScript enabled to view it
/svn/joomfish/development/trunk/2.x
# command to checkout the development trunk svn checkout http://
This e-mail address is being protected from spambots. You need JavaScript enabled to view it
/svn/joomfish/development/trunk/2.x ./jf20
# command to export the development trunk svn export http://
This e-mail address is being protected from spambots. You need JavaScript enabled to view it
/svn/joomfish/development/trunk/2.x ./jf20
# command to export one of the translations svn export http://
This e-mail address is being protected from spambots. You need JavaScript enabled to view it
/svn/joomfish/documentation/ui_translation/trunk/de-DE ./jf20_de-DE
The export is the best option if you just need a current version for a test installation or the translation of the files. It gives you a clean directory that you can ZIP and install using the Joomla installer.
|