Repository: couchdb Updated Branches: refs/heads/master 585ddafb5 -> e07cc8291
spell checking my-first-couchdb-plugin's README Project: http://git-wip-us.apache.org/repos/asf/couchdb/repo Commit: http://git-wip-us.apache.org/repos/asf/couchdb/commit/1db70b8c Tree: http://git-wip-us.apache.org/repos/asf/couchdb/tree/1db70b8c Diff: http://git-wip-us.apache.org/repos/asf/couchdb/diff/1db70b8c Branch: refs/heads/master Commit: 1db70b8c8037deb3ab64a4e43e4a7c5f80f7038e Parents: 13010ed Author: Mariano Guerra <[email protected]> Authored: Mon Mar 17 13:43:20 2014 +0100 Committer: Mariano Guerra <[email protected]> Committed: Mon Mar 17 13:43:20 2014 +0100 ---------------------------------------------------------------------- src/my-first-couchdb-plugin/README.md | 14 +++++++------- 1 file changed, 7 insertions(+), 7 deletions(-) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/couchdb/blob/1db70b8c/src/my-first-couchdb-plugin/README.md ---------------------------------------------------------------------- diff --git a/src/my-first-couchdb-plugin/README.md b/src/my-first-couchdb-plugin/README.md index 814ef3b..37c0a75 100644 --- a/src/my-first-couchdb-plugin/README.md +++ b/src/my-first-couchdb-plugin/README.md @@ -2,7 +2,7 @@ A practical guide to developing CouchDB plugins. -*NOTE: This is incomplete, barely tested, works only with the 1867-feature-plugin branch of Apache CouchDB and expects that you understand some Erlang. This is mostly for early review, but if you are daring, you can learn someting already :)* +*NOTE: This is incomplete, barely tested, works only with the 1867-feature-plugin branch of Apache CouchDB and expects that you understand some Erlang. This is mostly for early review, but if you are daring, you can learn something already :)* ## Preparation @@ -84,7 +84,7 @@ Note: from now on you can just type `make dev`, it will run `make` for you inter * * * -That is all that is needed to get started building a CouchDB plugin. The rest of this guide will explain how to hook into the various parts of CouchDB that allow you to do all sorts of fun things. That means you can write different types of plugins, once that handle HTTP requests, others that operate on database changes, and yet others that provide a deamon that does useful things for us. +That is all that is needed to get started building a CouchDB plugin. The rest of this guide will explain how to hook into the various parts of CouchDB that allow you to do all sorts of fun things. That means you can write different types of plugins, ones that handle HTTP requests, others that operate on database changes, and yet others that provide a daemon that does useful things for us. * * * @@ -111,9 +111,9 @@ Thatâs the easy part. The hard part is publishing the plugin. And since this i Our module above is not very useful on its own. You can call it when you are in the Erlang command prompt for your local CouchDB, but CouchDB itself doesnât know what to do with it and you canât do anything with it from CouchDBâs HTTP API. Letâs fix that! -CouchDBâs main API is HTTP and thus we can expect to have a lot of infrastructure to work with. Luckily, it is mostly straigtforward to get into and we donât need to learn a whole lot before can get started, and learn more as we go along. +CouchDBâs main API is HTTP and thus we can expect to have a lot of infrastructure to work with. Luckily, it is mostly straightforward to get into and we donât need to learn a whole lot before can get started, and learn more as we go along. -Before ge get goint, letâs create another file that handles all our HTTP handler code. Create `src/my_first_couchdb_plugin_httpd.erl` and put in the following contents: +Before we get going, letâs create another file that handles all our HTTP handler code. Create `src/my_first_couchdb_plugin_httpd.erl` and put in the following contents: -module(my_first_couchdb_plugin_httpd). @@ -142,11 +142,11 @@ Now we have a function that can handle HTTP requests, but we havenât told Couc To do this, we need to take a little detour into the CouchDB configuration system, as CouchDBâs HTTP routing is fully dynamic and configurable at runtime. -To get an idea, open this file in CouchDB source directory: `etc/couchdb/default.ini.tpl.in`, donât mind the triple file extensions, this is essentialy an `.ini` file. Now scroll down to the section `[httpd_global_handlers]`. You will find a list of API endpoints with mapping to the code in CouchDB that handles it. for example: +To get an idea, open this file in CouchDB source directory: `etc/couchdb/default.ini.tpl.in`, donât mind the triple file extensions, this is essentially an `.ini` file. Now scroll down to the section `[httpd_global_handlers]`. You will find a list of API endpoints with mapping to the code in CouchDB that handles it. for example: _utils = {couch_httpd_misc_handlers, handle_utils_dir_req, "%localdatadir%/www"} -This means that `/_utils` is handled by the erlang module `couch_httpd_misc_handlers` and its function `handle_utils_dir_req` and it takes one additinal argument that is the document root for Futon. +This means that `/_utils` is handled by the erlang module `couch_httpd_misc_handlers` and its function `handle_utils_dir_req` and it takes one additional argument that is the document root for Futon. Another example: @@ -154,7 +154,7 @@ Another example: This means that `/_all_dbs`, the API endpoint that allows you to list all databases in CouchDB is handled by, again, `couch_httpd_misc_handlers` but this time its function `handle_all_dbs_req`, which does not take an additional argument. -Say we want to make our `handle_req` function answer under the enpoint `/_my_plugin` (you want to start with an underscore here, as CouchDB will consider all other characters as real database names), we would add something like this: +Say we want to make our `handle_req` function answer under the endpoint `/_my_plugin` (you want to start with an underscore here, as CouchDB will consider all other characters as real database names), we would add something like this: _my_plugin = {my_first_couchdb_plugin, handle_req}
