Repository: cordova-docs Updated Branches: refs/heads/master d697d2b62 -> aada53a24 Added wiki details for crowdin best practices close #208 Project: http://git-wip-us.apache.org/repos/asf/cordova-docs/repo Commit: http://git-wip-us.apache.org/repos/asf/cordova-docs/commit/6f4b0108 Tree: http://git-wip-us.apache.org/repos/asf/cordova-docs/tree/6f4b0108 Diff: http://git-wip-us.apache.org/repos/asf/cordova-docs/diff/6f4b0108 Branch: refs/heads/master Commit: 6f4b01087ac331e6a0b10bc8509b4bb5bfa951b6 Parents: d697d2b Author: Lisa Seacat DeLuca <ld...@us.ibm.com> Authored: Fri May 30 10:54:01 2014 -0400 Committer: Andrew Grieve <ag...@chromium.org> Committed: Fri Jun 27 11:30:47 2014 -0400 ---------------------------------------------------------------------- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/6f4b0108/README.md ---------------------------------------------------------------------- diff --git a/README.md b/README.md index e935092..46491e5 100644 --- a/README.md +++ b/README.md @@ -60,7 +60,7 @@ With the support of <a href="http://crowdin.net/project/cordova">Crowdin</a>, a translation and localization management platform, translators can login to the easy-to-use tooling and provide as much or as little translation assistance as they would like. If you know another language please support Cordova and contribute. -<a href="http://crowdin.net/project/cordova">http://crowdin.net/project/cordova</a>. +<a href="http://crowdin.net/project/cordova">http://crowdin.net/project/cordova</a>. For some best practices for using the Crowdin tool please see our wiki <a href="http://wiki.apache.org/cordova/CordovaTranslations">http://wiki.apache.org/cordova/CordovaTranslations</a>. ordova language administrators, don't forget these steps:
CB-6698 Remove explicit `<source-file>` from example since `<framework>` now copies it in by default
Project: http://git-wip-us.apache.org/repos/asf/cordova-docs/repo
Commit: http://git-wip-us.apache.org/repos/asf/cordova-docs/commit/cfcf1de9
Tree: http://git-wip-us.apache.org/repos/asf/cordova-docs/tree/cfcf1de9
Diff: http://git-wip-us.apache.org/repos/asf/cordova-docs/diff/cfcf1de9
Branch: refs/heads/master
Commit: cfcf1de96b88cb416bab63292256afaf4542df7f
Parents: 900c43e
Author: Andrew Grieve <ag...@chromium.org>
Authored: Fri Jun 27 11:13:09 2014 -0400
Committer: Andrew Grieve <ag...@chromium.org>
Committed: Fri Jun 27 11:31:25 2014 -0400
----------------------------------------------------------------------
docs/en/edge/plugin_ref/spec.md | 6 ++----
1 file changed, 2 insertions(+), 4 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/cfcf1de9/docs/en/edge/plugin_ref/spec.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/plugin_ref/spec.md b/docs/en/edge/plugin_ref/spec.md
index 0885cbd..0767fc6 100644
--- a/docs/en/edge/plugin_ref/spec.md
+++ b/docs/en/edge/plugin_ref/spec.md
@@ -528,9 +528,7 @@ The optional `custom` attribute is a boolean indicating whether the framework is
The optional `type` attribute is a string indicating the type of framework to add. Currently only `projectReference` is supported and only on Windows 8. Using `custom='true'` and `type='projectReference'` will add a reference to the project which will be added to the compile+link steps of the cordova project. This essentially is the only way currently that a 'custom' framework can target multiple architectures as they are explicitly built as a dependency by the referencing cordova application.
The optional `parent` attribute is currently supported only on Android. It sets the relative path to the directory containing the sub-project to which to add the reference. The default is `.`, i.e. the application project. It allows to add references between sub projects like in this example:
-
- <source-file src="src/android/FeedbackLib" target-dir="./" />
-
+
<framework src="FeedbackLib" custom="true" />
<framework src="extras/android/support/v7/appcompat" custom="false" parent="FeedbackLib" />
@@ -544,7 +542,7 @@ plugman's scope. Examples:
You need to install __Google Play Services__ from the `Android Extras` section using the Android SDK manager (run `android`).
You need to add the following line to the `local.properties`:
-
+
android.library.reference.1=PATH_TO_ANDROID_SDK/sdk/extras/google/google_play_services/libproject/google-play-services_lib
</info>
CB-6344 CB-6698 `after` for `<config-changes>`, `<framework>` for Android close #210 Project: http://git-wip-us.apache.org/repos/asf/cordova-docs/repo Commit: http://git-wip-us.apache.org/repos/asf/cordova-docs/commit/900c43ef Tree: http://git-wip-us.apache.org/repos/asf/cordova-docs/tree/900c43ef Diff: http://git-wip-us.apache.org/repos/asf/cordova-docs/diff/900c43ef Branch: refs/heads/master Commit: 900c43ef42a3d793ef314ff3910a67f9296df0c0 Parents: d0a51e1 Author: Martin Bektchiev <ma...@telerik.com> Authored: Wed Jun 4 18:22:03 2014 +0300 Committer: Andrew Grieve <ag...@chromium.org> Committed: Fri Jun 27 11:30:55 2014 -0400 ---------------------------------------------------------------------- docs/en/edge/plugin_ref/spec.md | 11 ++++++++++- 1 file changed, 10 insertions(+), 1 deletion(-) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/900c43ef/docs/en/edge/plugin_ref/spec.md ---------------------------------------------------------------------- diff --git a/docs/en/edge/plugin_ref/spec.md b/docs/en/edge/plugin_ref/spec.md index 3c5eab5..0885cbd 100644 --- a/docs/en/edge/plugin_ref/spec.md +++ b/docs/en/edge/plugin_ref/spec.md @@ -452,6 +452,8 @@ It supports the following attributes: document, the tool stops and reverses the installation process, issues a warning, and exits with a non-zero code. +* `after`: A prioritized list of accepted siblings after which to add the XML snippet. Useful for specifying changes in files which require strict ordering of XML elements like [http://msdn.microsoft.com/en-us/library/windowsphone/develop/ff769509%28v=vs.105%29.aspx#BKMK_EXTENSIONSelement](http://msdn.microsoft.com/en-us/library/windowsphone/develop/ff769509%28v=vs.105%29.aspx#BKMK_EXTENSIONSelement) + ## _plugins-plist_ Element This is _outdated_ as it only applies to cordova-ios 2.2.0 and @@ -521,10 +523,17 @@ platform. The optional `weak` attribute is a boolean indicating whether the framework should be weakly linked. The default is `false`. -The optional `custom` attribute is a boolean indicating whether the framework is one that is included as part of your plugin files (thus it is not a system framework). The default is `false`. +The optional `custom` attribute is a boolean indicating whether the framework is one that is included as part of your plugin files (thus it is not a system framework). The default is `false`. ***On Android*** it specifies how to treat **src**. If `true` **src** is a relative path from the application project's directory, otherwise -- from the Android SDK directory. The optional `type` attribute is a string indicating the type of framework to add. Currently only `projectReference` is supported and only on Windows 8. Using `custom='true'` and `type='projectReference'` will add a reference to the project which will be added to the compile+link steps of the cordova project. This essentially is the only way currently that a 'custom' framework can target multiple architectures as they are explicitly built as a dependency by the referencing cordova application. +The optional `parent` attribute is currently supported only on Android. It sets the relative path to the directory containing the sub-project to which to add the reference. The default is `.`, i.e. the application project. It allows to add references between sub projects like in this example: + + <source-file src="src/android/FeedbackLib" target-dir="./" /> + + <framework src="FeedbackLib" custom="true" /> + <framework src="extras/android/support/v7/appcompat" custom="false" parent="FeedbackLib" /> + ## _info_ Element Additional information provided to users. This is useful when you
CB-2606 Base directory of <icon src= is the project directory NOT the www directory
Project: http://git-wip-us.apache.org/repos/asf/cordova-docs/repo
Commit: http://git-wip-us.apache.org/repos/asf/cordova-docs/commit/aada53a2
Tree: http://git-wip-us.apache.org/repos/asf/cordova-docs/tree/aada53a2
Diff: http://git-wip-us.apache.org/repos/asf/cordova-docs/diff/aada53a2
Branch: refs/heads/master
Commit: aada53a24db3597d5e30652cb7778ee838bdd98b
Parents: 91a5285
Author: ignisvulpis <ax...@nennker.de>
Authored: Thu Jun 5 14:44:01 2014 +0200
Committer: Andrew Grieve <ag...@chromium.org>
Committed: Fri Jun 27 11:32:49 2014 -0400
----------------------------------------------------------------------
docs/en/3.5.0/config_ref/images.md | 2 +-
docs/en/edge/config_ref/images.md | 2 +-
2 files changed, 2 insertions(+), 2 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/aada53a2/docs/en/3.5.0/config_ref/images.md
----------------------------------------------------------------------
diff --git a/docs/en/3.5.0/config_ref/images.md b/docs/en/3.5.0/config_ref/images.md
index 01dda5a..acd8913 100644
--- a/docs/en/3.5.0/config_ref/images.md
+++ b/docs/en/3.5.0/config_ref/images.md
@@ -31,7 +31,7 @@ If you do not specify an icon then the Apache Cordova logo is used.
<icon src="res/ios/icon.png" platform="ios" width="57" height="57" density="mdpi" />
-src: (required) specifies the location of the image file, relative to your www directory
+src: (required) specifies the location of the image file, relative to your project directory
platform: (optional) target platform
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/aada53a2/docs/en/edge/config_ref/images.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/config_ref/images.md b/docs/en/edge/config_ref/images.md
index 01dda5a..acd8913 100644
--- a/docs/en/edge/config_ref/images.md
+++ b/docs/en/edge/config_ref/images.md
@@ -31,7 +31,7 @@ If you do not specify an icon then the Apache Cordova logo is used.
<icon src="res/ios/icon.png" platform="ios" width="57" height="57" density="mdpi" />
-src: (required) specifies the location of the image file, relative to your www directory
+src: (required) specifies the location of the image file, relative to your project directory
platform: (optional) target platform
Use markdown-style links instead of <a> tags in README.md Project: http://git-wip-us.apache.org/repos/asf/cordova-docs/repo Commit: http://git-wip-us.apache.org/repos/asf/cordova-docs/commit/d0a51e11 Tree: http://git-wip-us.apache.org/repos/asf/cordova-docs/tree/d0a51e11 Diff: http://git-wip-us.apache.org/repos/asf/cordova-docs/diff/d0a51e11 Branch: refs/heads/master Commit: d0a51e113eed356a32409f3ae0825eb9117321fa Parents: 6f4b010 Author: Andrew Grieve <ag...@chromium.org> Authored: Fri Jun 27 11:09:47 2014 -0400 Committer: Andrew Grieve <ag...@chromium.org> Committed: Fri Jun 27 11:30:55 2014 -0400 ---------------------------------------------------------------------- README.md | 7 ++++--- 1 file changed, 4 insertions(+), 3 deletions(-) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/d0a51e11/README.md ---------------------------------------------------------------------- diff --git a/README.md b/README.md index 46491e5..d390ae4 100644 --- a/README.md +++ b/README.md @@ -56,13 +56,14 @@ We appreciate the use of topic branches. ### Adding a Language Do you want the Apache Cordova documentation in another language? We do too! -With the support of <a href="http://crowdin.net/project/cordova">Crowdin</a>, +With the support of [Crowdin](http://crowdin.net/project/cordova), a translation and localization management platform, translators can login to the easy-to-use tooling and provide as much or as little translation assistance as they would like. If you know another language please support Cordova and contribute. -<a href="http://crowdin.net/project/cordova">http://crowdin.net/project/cordova</a>. For some best practices for using the Crowdin tool please see our wiki <a href="http://wiki.apache.org/cordova/CordovaTranslations">http://wiki.apache.org/cordova/CordovaTranslations</a>. +http://crowdin.net/project/cordova. For some best practices for using the +Crowdin tool please see our wiki http://wiki.apache.org/cordova/CordovaTranslations. -ordova language administrators, don't forget these steps: +Cordova language administrators, don't forget these steps: __1. config.json__
Added details for people wishing to help translate Project: http://git-wip-us.apache.org/repos/asf/cordova-docs/repo Commit: http://git-wip-us.apache.org/repos/asf/cordova-docs/commit/91a52859 Tree: http://git-wip-us.apache.org/repos/asf/cordova-docs/tree/91a52859 Diff: http://git-wip-us.apache.org/repos/asf/cordova-docs/diff/91a52859 Branch: refs/heads/master Commit: 91a5285978adae97f948116fea7e702bb3b258c7 Parents: cfcf1de Author: Lisa Seacat DeLuca <ld...@us.ibm.com> Authored: Fri May 30 10:57:58 2014 -0400 Committer: Andrew Grieve <ag...@chromium.org> Committed: Fri Jun 27 11:31:41 2014 -0400 ---------------------------------------------------------------------- CONTRIBUTING.md | 18 ++++++++++++++++++ 1 file changed, 18 insertions(+) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/91a52859/CONTRIBUTING.md ---------------------------------------------------------------------- diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index f7dbcab..1c9722c 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -35,3 +35,21 @@ The details are explained there, but the important items are: - Run the tests so your patch doesn't break existing functionality. We look forward to your contributions! + +# Translating Apache Cordova +Apache Cordova's documentation is written in English but translations are available in a number of different languages. These languages are chosen based on volunteers who are willing to help translate from English to their native tongue. We use Crowdin, a translation and localization management platform to collaborate amongst translators and our core team. + +## The Process of Translating + +If you know another language and are willing to help translate Apache Cordova, here are the steps to get started: + +1. Create a free account with Crowdin.net [http://crowdin.net](http://crowdin.net) +2. Search for and find the Cordova project [http://crowdin.net/project/cordova/](http://crowdin.net/project/cordova/) +3. Scroll down to find the languages that are currently being translated. +4. Choose a language and click on the language to start contributing. e.g. Spanish http://crowdin.net/project/cordova/es-ES +5. Next to each of the markdown files you will see a button labelled "Translate". Clicking that button will open a translate page where the English version of the file is on the left. +6. Click on a phrase in the left-hand panel. Then type a translation in the textarea to the right. Click the "Commit Translation" button. +If a translation is already provided for a phrase you can vote it up or down. If you vote it down be sure to also include what you believe to be the correct translation. + +## Tips +The headers are used to provide links between pages. It is therefore critical that these headers have the exact same translation character for character. Otherwise, the links will appear broken. If, when building a language, a link is problem, check that the translations match.