You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@cordova.apache.org by aendu <gi...@git.apache.org> on 2014/04/25 10:40:18 UTC
[GitHub] cordova-plugin-file pull request: Update index.md
GitHub user aendu opened a pull request:
https://github.com/apache/cordova-plugin-file/pull/41
Update index.md
As i had to figure this all out by myself i though we better share this info with everybody.
There is a lot of outdated info on the net and also on the cordova docu page. I would like to make a pull request there as well, but unfortunately i don't know how.
(http://cordova.apache.org/docs/en/3.0.0/cordova_file_file.md.html)
You can merge this pull request into a Git repository by running:
$ git pull https://github.com/aendu/cordova-plugin-file patch-1
Alternatively you can review and apply these changes as the patch at:
https://github.com/apache/cordova-plugin-file/pull/41.patch
To close this pull request, make a commit to your master/trunk branch
with (at least) the following in the commit message:
This closes #41
----
commit 28d0b3d6cc2436f9f57900a8fd011ff45731f93b
Author: aendu <ae...@gmail.com>
Date: 2014-04-25T08:40:08Z
Update index.md
As i had to figure this all out by myself i though we better share this info with everybody.
There is a lot of outdated info on the net and also on the cordova docu page. I would like to make a pull request there as well, but unfortunately i don't know how.
(http://cordova.apache.org/docs/en/3.0.0/cordova_file_file.md.html)
----
---
If your project is set up for it, you can reply to this email and have your
reply appear on GitHub as well. If your project does not have this feature
enabled and wishes so, or if the feature is enabled but not working, please
contact infrastructure at infrastructure@apache.org or file a JIRA ticket
with INFRA.
---
[GitHub] cordova-plugin-file pull request: Update index.md
Posted by asfgit <gi...@git.apache.org>.
Github user asfgit closed the pull request at:
https://github.com/apache/cordova-plugin-file/pull/41
---
If your project is set up for it, you can reply to this email and have your
reply appear on GitHub as well. If your project does not have this feature
enabled and wishes so, or if the feature is enabled but not working, please
contact infrastructure at infrastructure@apache.org or file a JIRA ticket
with INFRA.
---
[GitHub] cordova-plugin-file pull request: Update index.md
Posted by jsoref <gi...@git.apache.org>.
Github user jsoref commented on a diff in the pull request:
https://github.com/apache/cordova-plugin-file/pull/41#discussion_r12001097
--- Diff: doc/index.md ---
@@ -24,6 +24,20 @@ to HTML5 Rocks' [FileSystem article](http://www.html5rocks.com/en/tutorials/file
on the subject. For an overview of other storage options, refer to Cordova's
[storage guide](http://cordova.apache.org/docs/en/edge/cordova_storage_storage.md.html).
+Over the standard file systems (`LocalFileSystem.PERSISTENCE` and `LocalFileSystem.TEMPORARY`) the cordova file plug-in allows access to further file systems. To use them, one needs to configure which are allowed for the application (see section configuration). To access a file within one of these file systems, use the following command:
--- End diff --
**Cordova** should be uppercase here.
Also, **File Plug-in** probably should be too.
I'm not sure about conventions for long lines, but based on 24+25, it looks like you should wrap at around 80 cols.
if `configuration` is a section, it probably should have *some* markdown.
---
If your project is set up for it, you can reply to this email and have your
reply appear on GitHub as well. If your project does not have this feature
enabled and wishes so, or if the feature is enabled but not working, please
contact infrastructure at infrastructure@apache.org or file a JIRA ticket
with INFRA.
---
[GitHub] cordova-plugin-file pull request: Update index.md
Posted by clelland <gi...@git.apache.org>.
Github user clelland commented on the pull request:
https://github.com/apache/cordova-plugin-file/pull/41#issuecomment-46578802
I think that the point of this doc change, which was to document how to use `window.resolveLocalFileSystemURL` to use all of the new paths, has been covered by commit f92017f
The current docs, at https://github.com/apache/cordova-plugin-file/blob/master/doc/index.md#where-to-store-files, explain the situation well.
---
If your project is set up for it, you can reply to this email and have your
reply appear on GitHub as well. If your project does not have this feature
enabled and wishes so, or if the feature is enabled but not working, please
contact infrastructure at infrastructure@apache.org or file a JIRA ticket
with INFRA.
---
[GitHub] cordova-plugin-file pull request: Update index.md
Posted by clelland <gi...@git.apache.org>.
Github user clelland commented on a diff in the pull request:
https://github.com/apache/cordova-plugin-file/pull/41#discussion_r13016951
--- Diff: doc/index.md ---
@@ -24,6 +24,20 @@ to HTML5 Rocks' [FileSystem article](http://www.html5rocks.com/en/tutorials/file
on the subject. For an overview of other storage options, refer to Cordova's
[storage guide](http://cordova.apache.org/docs/en/edge/cordova_storage_storage.md.html).
+Over the standard file systems (`LocalFileSystem.PERSISTENCE` and `LocalFileSystem.TEMPORARY`) the cordova file plug-in allows access to further file systems. To use them, one needs to configure which are allowed for the application (see section configuration). To access a file within one of these file systems, use the following command:
--- End diff --
Also, these should just be `PERSISTENT` and `TEMPORARY` -- the `LocalFileSystem` prefix isn't necessary anymore, and `PERSIST*ENCE*` is just wrong.
---
If your project is set up for it, you can reply to this email and have your
reply appear on GitHub as well. If your project does not have this feature
enabled and wishes so, or if the feature is enabled but not working, please
contact infrastructure at infrastructure@apache.org or file a JIRA ticket
with INFRA.
---
[GitHub] cordova-plugin-file pull request: Update index.md
Posted by jsoref <gi...@git.apache.org>.
Github user jsoref commented on a diff in the pull request:
https://github.com/apache/cordova-plugin-file/pull/41#discussion_r12001137
--- Diff: doc/index.md ---
@@ -24,6 +24,20 @@ to HTML5 Rocks' [FileSystem article](http://www.html5rocks.com/en/tutorials/file
on the subject. For an overview of other storage options, refer to Cordova's
[storage guide](http://cordova.apache.org/docs/en/edge/cordova_storage_storage.md.html).
+Over the standard file systems (`LocalFileSystem.PERSISTENCE` and `LocalFileSystem.TEMPORARY`) the cordova file plug-in allows access to further file systems. To use them, one needs to configure which are allowed for the application (see section configuration). To access a file within one of these file systems, use the following command:
+
+ `window.resolveLocalFileSystemURL(path, cbSuccess, cbFail);`
+
+ * @param path: {string} a cordova path with scheme: `cdvfile://localhost/<file-system-name>/<path-to-file>` <br/>Examples:
--- End diff --
**Cordova** again here. The rule is "unless you mean `cordova` the command line tool, spell it as the brand **Cordova**."
---
If your project is set up for it, you can reply to this email and have your
reply appear on GitHub as well. If your project does not have this feature
enabled and wishes so, or if the feature is enabled but not working, please
contact infrastructure at infrastructure@apache.org or file a JIRA ticket
with INFRA.
---