diff options
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/Developers.md | 8 | ||||
| -rw-r--r-- | doc/Translations.md | 30 | ||||
| -rw-r--r-- | doc/developer/developer_guide.bb | 28 | ||||
| -rw-r--r-- | doc/developers.bb | 11 |
4 files changed, 37 insertions, 40 deletions
diff --git a/doc/Developers.md b/doc/Developers.md index ef02c8327..b1f185c2e 100644 --- a/doc/Developers.md +++ b/doc/Developers.md @@ -8,17 +8,17 @@ doing development. Create your own github account. -You may fork/clone the Red repository from [https://github.com/redmatrix/hubzilla.git](https://github.com/redmatrix/hubzilla.git). +You may fork/clone the $Projectname repository from [https://framagit.org/hubzilla/core.git](https://framagit.org/hubzilla/core.git). Follow the instructions provided here: [http://help.github.com/fork-a-repo/](http://help.github.com/fork-a-repo/) -to create and use your own tracking fork on github +to create and use your own tracking fork on framagit -Then go to your github page and create a "Pull request" when you are ready +Then go to your gramagit page and create a "Pull request" when you are ready to notify us to merge your work. **Translations** -Our translations are managed through Transifex. If you wish to help out translating $Projectname to another language, sign up on transifex.com, visit [https://www.transifex.com/projects/p/red-matrix/](https://www.transifex.com/projects/p/red-matrix/) and request to join one of the existing language teams or create a new one. Notify one of the core developers when you have a translation update which requires merging, or ask about merging it yourself if you're comfortable with git and PHP. We have a string file called 'messages.po' which is gettext compliant and a handful of email templates, and from there we automatically generate the application's language files. +Our translations are managed through Transifex. If you wish to help out translating $Projectname to another language, sign up on transifex.com, visit [https://www.transifex.com/projects/p/hubzilla/](https://www.transifex.com/projects/p/hubzilla/) and request to join one of the existing language teams or create a new one. Notify one of the core developers when you have a translation update which requires merging, or ask about merging it yourself if you're comfortable with git and PHP. We have a string file called 'messages.po' which is gettext compliant and a handful of email templates, and from there we automatically generate the application's language files. [Translations - More Info](help/Translations) diff --git a/doc/Translations.md b/doc/Translations.md index 654ba1b83..6106e43b1 100644 --- a/doc/Translations.md +++ b/doc/Translations.md @@ -4,13 +4,13 @@ Translating $Projectname Translation Process ------------------- -The strings used in the UI of Hubzilla is translated at [Transifex][1] and then +The strings used in the UI of $Projectname is translated at [Transifex][1] and then included in the git repository at github. If you want to help with translation -for any language, be it correcting terms or translating Hubzilla to a +for any language, be it correcting terms or translating $Projectname to a currently not supported language, please register an account at transifex.com and contact the Redmatrix translation team there. -Translating Hubzilla is simple. Just use the online tool at transifex. If you +Translating $Projectname is simple. Just use the online tool at transifex. If you don't want to deal with git & co. that is fine, we check the status of the translations regularly and import them into the source tree at github so that others can use them. @@ -26,32 +26,32 @@ tree. If you want to get your work into the source tree yourself, feel free to do so and contact us with and question that arises. The process is simple and -Hubzilla ships with all the tools necessary. +$Projectname ships with all the tools necessary. The location of the translated files in the source tree is /view/LNG-CODE/ where LNG-CODE is the language code used, e.g. de for German or fr for French. For the email templates (the *.tpl files) just place them into the directory and you are done. The translated strings come as a "hmessages.po" file from -transifex which needs to be translated into the PHP file Hubzilla uses. To do +transifex which needs to be translated into the PHP file $Projectname uses. To do so, place the file in the directory mentioned above and use the "po2php" -utility from the util directory of your Hubzilla installation. +utility from the util directory of your $Projectname installation. Assuming you want to convert the German localization which is placed in view/de/hmessages.po you would do the following. 1. Navigate at the command prompt to the base directory of your - Hubzilla installation + $Projectname installation 2. Execute the po2php script, which will place the translation - in the hstrings.php file that is used by Hubzilla. + in the hstrings.php file that is used by $Projectname. $> php util/po2php.php view/de/hmessages.po The output of the script will be placed at view/de/hstrings.php where froemdoca os expecting it, so you can test your translation mmediately. -3. Visit your Hubzilla page to check if it still works in the language you +3. Visit your $Projectname page to check if it still works in the language you just translated. If not try to find the error, most likely PHP will give you a hint in the log/warnings.about the error. @@ -62,16 +62,16 @@ view/de/hmessages.po you would do the following. $> php view/de/hstrings.php 4. commit the two files with a meaningful commit message to your git - repository, push it to your fork of the Hubzilla repository at github and + repository, push it to your fork of the $Projectname repository at github and issue a pull request for that commit. Utilities --------- Additional to the po2php script there are some more utilities for translation -in the "util" directory of the Hubzilla source tree. If you only want to -translate Hubzilla into another language you wont need any of these tools most -likely but it gives you an idea how the translation process of Hubzilla +in the "util" directory of the $Projectname source tree. If you only want to +translate $Projectname into another language you wont need any of these tools most +likely but it gives you an idea how the translation process of $Projectname works. For further information see the utils/README file. @@ -79,7 +79,7 @@ For further information see the utils/README file. Known Problems -------------- -* Hubzilla uses the language setting of the visitors browser to determain the +* $Projectname uses the language setting of the visitors browser to determain the language for the UI. Most of the time this works, but there are some known quirks. * the early translations are based on the friendica translations, if you @@ -87,7 +87,7 @@ Known Problems Links ------ -[1]: http://www.transifex.com/projects/p/red-matrix/ +[1]: http://www.transifex.com/projects/p/hubzilla/ #include doc/macros/main_footer.bb; diff --git a/doc/developer/developer_guide.bb b/doc/developer/developer_guide.bb index f8ba0c1d8..d04cec121 100644 --- a/doc/developer/developer_guide.bb +++ b/doc/developer/developer_guide.bb @@ -53,29 +53,27 @@ The [url=[baseurl]/help/admin/hub_snapshots]hub snapshots[/url] page provides in [h3]Translations[/h3] -Our translations are managed through Transifex. If you wish to help out translating $Projectname to another language, sign up on transifex.com, visit [url=https://www.transifex.com/Friendica/red-matrix/]Transifex[/url] and request to join one of the existing language teams or create a new one. Notify one of the core developers when you have a translation update which requires merging, or ask about merging it yourself if you're comfortable with git and PHP. We have a string file called 'messages.po' which is gettext compliant and a handful of email templates, and from there we automatically generate the application's language files. +Our translations are managed through Transifex. If you wish to help out translating $Projectname to another language, sign up on transifex.com, visit [url=https://www.transifex.com/Friendica/hubzilla/]Transifex[/url] and request to join one of the existing language teams or create a new one. Notify one of the core developers when you have a translation update which requires merging, or ask about merging it yourself if you're comfortable with git and PHP. We have a string file called 'messages.po' which is gettext compliant and a handful of email templates, and from there we automatically generate the application's language files. [h4]Translation Process[/h4] -The strings used in the UI of $Projectname is translated at [url=https://www.transifex.com/Friendica/red-matrix/]Transifex[/url] and then +The strings used in the UI of $Projectname is translated at [url=https://www.transifex.com/Friendica/hubzilla/]Transifex[/url] and then included in the git repository at github. If you want to help with translation for any language, be it correcting terms or translating $Projectname to a currently not supported language, please register an account at transifex.com -and contact the Redmatrix translation team there. +and contact the translation team there. Translating $Projectname is simple. Just use the online tool at transifex. If you -don't want to deal with git & co. that is fine, we check the status of the[/td][/tr] -[tr]ranslations regularly and import them into the source tree at github so that -others can use them. +don't want to deal with git & co. that is fine, we check the status of the translations +regularly and import them into the source tree at github so that others can use them. We do not include every translation from transifex in the source tree to avoid a scattered and disturbed overall experience. As an uneducated guess we have a lower limit of 50% translated strings before we include the language. This -limit is judging only by the amount of translated strings under the assumption[/td][/tr] -[tr]hat the most prominent strings for the UI will be translated first by a[/td][/tr] -[tr]ranslation team. If you feel your translation useable before this limit, -please contact us and we will probably include your teams work in the source[/td][/tr] -[tr]ree. +limit is judging only by the amount of translated strings under the assumption +that the most prominent strings for the UI will be translated first by a translation +team. If you feel your translation useable before this limit, +please contact us and we will probably include your teams work in the source tree. If you want to get your work into the source tree yourself, feel free to do so and contact us with and question that arises. The process is simple and @@ -85,8 +83,8 @@ The location of the translated files in the source tree is /view/LNG-CODE/ where LNG-CODE is the language code used, e.g. de for German or fr for French. For the email templates (the *.tpl files) just place them into the directory -and you are done. The translated strings come as a "hmessages.po" file from[/td][/tr] -[tr]ransifex which needs to be translated into the PHP file $Projectname uses. To do +and you are done. The translated strings come as a "hmessages.po" file from +Transifex which needs to be translated into the PHP file $Projectname uses. To do so, place the file in the directory mentioned above and use the "po2php" utility from the util directory of your $Projectname installation. @@ -121,8 +119,8 @@ view/de/hmessages.po you would do the following. [h4]Utilities[/h4] Additional to the po2php script there are some more utilities for translation -in the "util" directory of the $Projectname source tree. If you only want to[/td][/tr] -[tr]ranslate $Projectname into another language you wont need any of these tools most +in the "util" directory of the $Projectname source tree. If you only want to +translate $Projectname into another language you wont need any of these tools most likely but it gives you an idea how the translation process of $Projectname works. diff --git a/doc/developers.bb b/doc/developers.bb index f8489640b..c8eec04ca 100644 --- a/doc/developers.bb +++ b/doc/developers.bb @@ -9,17 +9,17 @@ doing development. Create your own github account.
-You may fork/clone the Red repository from [url=https://github.com/redmatrix/hubzilla.git]https://github.com/redmatrix/hubzilla.git[/url]
+You may fork/clone the project repository from [url=https://framagit.org/hubzilla.core.git]https://framgit.org/hubzilla/core.git[/url]
Follow the instructions provided here: [url=http://help.github.com/fork-a-repo/]http://help.github.com/fork-a-repo/[/url]
-to create and use your own tracking fork on github
+to create and use your own tracking fork on framagit
-Then go to your github page and create a "Pull request" when you are ready
+Then go to your framagit page and create a "Pull request" when you are ready
to notify us to merge your work.
[b]Translations[/b]
-Our translations are managed through Transifex. If you wish to help out translating $Projectname to another language, sign up on transifex.com, visit [url=https://www.transifex.com/projects/p/red-matrix/]https://www.transifex.com/projects/p/red-matrix/[/url] and request to join one of the existing language teams or create a new one. Notify one of the core developers when you have a translation update which requires merging, or ask about merging it yourself if you're comfortable with git and PHP. We have a string file called 'messages.po' which is gettext compliant and a handful of email templates, and from there we automatically generate the application's language files.
+Our translations are managed through Transifex. If you wish to help out translating $Projectname to another language, sign up on transifex.com, visit [url=https://www.transifex.com/projects/p/hubzilla/]https://www.transifex.com/projects/p/hubzilla/[/url] and request to join one of the existing language teams or create a new one. Notify one of the core developers when you have a translation update which requires merging, or ask about merging it yourself if you're comfortable with git and PHP. We have a string file called 'hmessages.po' which is gettext compliant and a handful of email templates, and from there we automatically generate the application's language files.
[zrl=[baseurl]/help/Translations]Translations - More Info[/zrl]
@@ -29,7 +29,6 @@ Please pull in any changes from the project repository and merge them with your Also - **test your changes**. Don't assume that a simple fix won't break something else. If possible get an experienced Red developer to review the code.
-Further documentation can be found at the Github wiki pages at: [url=https://github.com/friendica/red/wiki]https://github.com/friendica/red/wiki[/url]
[b]Licensing[/b]
@@ -39,7 +38,7 @@ All code contributed to the project falls under the MIT license, unless otherwis Code changes which fix an obvious bug are pretty straight-forward. For instance if you click "Save" and the thing you're trying to save isn't saved, it's fairly obvious what the intended behaviour should be. Often when developing feature requests, it may affect large numbers of community members and it's possible that other members of the community won't agree with the need for the feature, or with your proposed implementation. They may not see something as a bug or a desirable feature.
-We encourage consensus building within the community when it comes to any feature which might be considered controversial or where there isn't unanimous decision that the proposed feature is the correct way to accomplish the task. The first place to pitch your ideas is to [url=https://zothub.com/channel/one]Channel One[/url]. Others may have some input or be able to point out facets of your concept which might be problematic in our environment. But also, you may encounter opposition to your plan. This doesn't mean you should stop and/or ignore the feature. Listen to the concerns of others and try and work through any implementation issues.
+We encourage consensus building within the community when it comes to any feature which might be considered controversial or where there isn't unanimous decision that the proposed feature is the correct way to accomplish the task. The first place to pitch your ideas is to the [url=https://project.hubzilla.org/channel/hubzilla]Hubzilla Development[/url] forum. Others may have some input or be able to point out facets of your concept which might be problematic in our environment. But also, you may encounter opposition to your plan. This doesn't mean you should stop and/or ignore the feature. Listen to the concerns of others and try and work through any implementation issues.
There are places where opposition cannot be resolved. In these cases, please consider making your feature [b]optional[/b] or non-default behaviour that must be specifically enabled. This technique can often be used when a feature has significant but less than unanimous support. Those who desire the feature can turn it on and those who don't want it - will leave it turned off.
|