You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@cordova.apache.org by db...@apache.org on 2015/07/24 00:21:11 UTC
[67/75] docs commit: Adding Cordova website.
Adding Cordova website.
Project: http://git-wip-us.apache.org/repos/asf/cordova-docs/repo
Commit: http://git-wip-us.apache.org/repos/asf/cordova-docs/commit/fcb4d7c1
Tree: http://git-wip-us.apache.org/repos/asf/cordova-docs/tree/fcb4d7c1
Diff: http://git-wip-us.apache.org/repos/asf/cordova-docs/diff/fcb4d7c1
Branch: refs/heads/cordova-website
Commit: fcb4d7c1858665917b1c1180eff2165a3baacd92
Parents: 5f55495
Author: Dmitry Blotsky <dm...@gmail.com>
Authored: Thu Jul 23 15:16:45 2015 -0700
Committer: Dmitry Blotsky <dm...@gmail.com>
Committed: Thu Jul 23 15:16:45 2015 -0700
----------------------------------------------------------------------
.gitignore | 22 +-
CONTRIBUTING.md | 6 +-
Makefile | 81 ++++++
README.md | 335 +++++++++-------------
STYLESHEET.md | 408 ---------------------------
_config.yml | 42 +++
doc/STYLEGUIDE.md | 408 +++++++++++++++++++++++++++
package.json | 36 +--
www/_data/index-config.yml | 319 +++++++++++++++++++++
www/_includes/analytics.html | 9 +
www/_includes/footer.html | 14 +
www/_includes/head.html | 19 ++
www/_includes/header.html | 29 ++
www/_includes/links.html | 53 ++++
www/_layouts/cordova.html | 11 +
www/_layouts/docs-de.html | 6 +
www/_layouts/docs-en.html | 7 +
www/_layouts/docs-es.html | 7 +
www/_layouts/docs-fr.html | 8 +
www/_layouts/docs-it.html | 6 +
www/_layouts/docs-ja.html | 6 +
www/_layouts/docs-ko.html | 6 +
www/_layouts/docs-pl.html | 6 +
www/_layouts/docs-ru.html | 14 +
www/_layouts/docs-sl.html | 6 +
www/_layouts/docs-zh.html | 6 +
www/_layouts/docs.html | 49 ++++
www/_layouts/post.html | 11 +
www/artwork.html | 43 +++
www/blog/index.html | 17 ++
www/favicon.ico | Bin 0 -> 1150 bytes
www/feed.xml | 30 ++
www/index.html | 213 ++++++++++++++
www/infra/doap_Cordova.rdf | 152 ++++++++++
www/infra/doap_Cordova_PMC.rdf | 31 ++
www/wiki-images/contributor-git.graphml | 373 ++++++++++++++++++++++++
www/wiki-images/contributor-git.png | Bin 0 -> 29386 bytes
37 files changed, 2148 insertions(+), 641 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/fcb4d7c1/.gitignore
----------------------------------------------------------------------
diff --git a/.gitignore b/.gitignore
index 0f60d79..59918a3 100644
--- a/.gitignore
+++ b/.gitignore
@@ -1,15 +1,7 @@
-.DS_Store
-tmp/
-node_modules/
-v8.log
-public/
-release/
-TAGS
-,*
-_*
-/joDoc/
-/markdown
-/Gemfile.lock
-*Screen Shot [0-9]*
-/.vagrant
-/npm-debug.log
+public
+*.pyc
+_defaults.yml
+www/_data/toc/*
+www/_data/languages.yml
+node_modules
+www/static/css/master.css
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/fcb4d7c1/CONTRIBUTING.md
----------------------------------------------------------------------
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
index 1c9722c..ce3e0a5 100644
--- a/CONTRIBUTING.md
+++ b/CONTRIBUTING.md
@@ -26,7 +26,7 @@ Anyone can contribute to Cordova. And we need your contributions.
There are multiple ways to contribute: report bugs, improve the docs, and
contribute code.
-For instructions on this, start with the
+For instructions on this, start with the
[contribution overview](http://cordova.apache.org/#contribute).
The details are explained there, but the important items are:
@@ -36,7 +36,8 @@ The details are explained there, but the important items are:
We look forward to your contributions!
-# Translating Apache Cordova
+# Translating Documentation
+
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
@@ -52,4 +53,5 @@ If you know another language and are willing to help translate Apache Cordova, h
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.
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/fcb4d7c1/Makefile
----------------------------------------------------------------------
diff --git a/Makefile b/Makefile
new file mode 100644
index 0000000..c45f1f5
--- /dev/null
+++ b/Makefile
@@ -0,0 +1,81 @@
+# constants
+SOURCE_DIR = www
+BUILD_DIR = public
+BIN_DIR = tools/bin
+
+SUDO = sudo
+LESS = ./node_modules/.bin/lessc
+
+RUBY_DEPS = jekyll rdiscount
+
+LESS_FILES = $(wildcard $(SOURCE_DIR)/static/css/*.less)
+GEN_CSS_FILES = $(LESS_FILES:.less=.css)
+
+LANGUAGES_FILE = $(SOURCE_DIR)/_data/languages.yml
+DEFAULTS_FILE = _defaults.yml
+JEKYLL_CONFIGS = _config.yml $(DEFAULTS_FILE)
+COMMA = ,
+EMPTY =
+SPACE = $(EMPTY) $(EMPTY)
+CONFIGS_ARG = $(subst $(SPACE),$(COMMA),$(JEKYLL_CONFIGS))
+JEKYLL_FLAGS = --trace --config $(CONFIGS_ARG)
+
+# OS-specific config
+ifdef $(WINDOWS)
+SUDO =
+endif
+
+# targets
+help usage:
+ @echo make build
+ @echo make serve
+ @echo
+ @echo make install/uninstall
+ @echo make link-bugs
+ @echo
+ @echo make clean
+ @echo make nuke
+
+build serve: link-bugs $(GEN_CSS_FILES) $(DEFAULTS_FILE) $(LANGUAGES_FILE) toc
+
+build:
+ jekyll build $(JEKYLL_FLAGS)
+
+serve:
+ jekyll serve --watch $(JEKYLL_FLAGS)
+
+$(DEFAULTS_FILE):
+ python $(BIN_DIR)/gen_defaults.py $(SOURCE_DIR)/docs/ > $@
+
+$(LANGUAGES_FILE):
+ python $(BIN_DIR)/gen_languages.py $(SOURCE_DIR)/docs/ > $@
+
+toc:
+ python $(BIN_DIR)/gen_toc.py $(SOURCE_DIR)
+
+link-bugs:
+ $(BIN_DIR)/linkify-bugs.sh $(SOURCE_DIR)/_posts
+
+$(LESS):
+ $(MAKE) install
+
+install:
+ npm install
+ $(SUDO) gem install $(RUBY_DEPS)
+
+uninstall:
+ $(RM) -r node_modules
+ $(SUDO) gem uninstall $(RUBY_DEPS)
+
+clean:
+ $(RM) -r $(BUILD_DIR)
+ $(RM) $(GEN_CSS_FILES)
+ $(RM) -r $(SOURCE_DIR)/_data/toc/*
+ $(RM) $(LANGUAGES_FILE) $(DEFAULTS_FILE)
+
+nuke: clean uninstall
+
+# pattern rules
+%.css: %.less $(LESS)
+ $(LESS) $< > $@
+
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/fcb4d7c1/README.md
----------------------------------------------------------------------
diff --git a/README.md b/README.md
index a1e9eb2..af8fe39 100644
--- a/README.md
+++ b/README.md
@@ -1,259 +1,194 @@
-Apache Cordova API Documentation
-================================
+Cordova Website
+===============
-The JavaScript API documentation for [Apache Cordova](http://cordova.io/).
+Get the source code
+-------------------
-The documentation is available at [docs.cordova.io](http://docs.cordova.io/).
+ $ svn checkout https://svn.apache.org/repos/asf/cordova/site cordova-website
-Documentation Format
---------------------
+Installing Dependencies
+----------------------------
-All of the [Apache Cordova](http://cordova.io/) documentation is written with [markdown](http://daringfireball.net/projects/markdown/syntax), a lightweight markup language that can be typeset to HTML. Markdown provides a simple and flexible way to document Cordova's core API and platform-specific APIs.
+This is all handled for you now via a VM and Vagrant.
+Install Vagrant and VirtualBox if you haven't already done so, then:
-File Structure
---------------
+ $ cd cordova-website/
+ $ vagrant up
+ $ vagrant ssh
+ $ cd /vagrant
- docs/
- docs/LANGUAGE
- docs/LANGUAGE/VERSION
- docs/LANGUAGE/VERSION/cordova/
- docs/LANGUAGE/VERSION/guide/platforms/PLATFORMNAME/
+Then you can continue with `rake build` as described below, and the output
+will be generated in the shared directory. You should do your
+svn commands outside of the VM, so that you aren't required to set up your
+svn credentials inside the VM. You can also do `rake serve` in the VM,
+and open "http://localhost:4000" in your bare-metal workstation browser,
+and it should work as port 4000 traffic is passed through from your workstation
+to the VM.
-Contributing to the Documentation
----------------------------------
+When you are done using `rake build` and `rake serve`, you can exit from
+the `vagrant ssh` shell to return to your bare metal machine, then
+run `vagrant halt` to gracefully shutdown the VM.
-### Report or Fix an Issue
+How to compile the site
+-----------------------
-We use [Apache JIRA](https://issues.apache.org/jira/browse/CB)
+ # change to the cordova website directory.
+ $ cd /path/to/cordova-website
-By the way, you rock! Thanks for helping us improve the documentation!
+ # compile the site. Note that if you change a blog entry (i.e., grunt updateBlog), you will need to re-run "rake build".
+ $ rake build
-### Using Git
+ # the site is generated in `public/` with an index.html file that
+ # can be opened using:
+ $ rake serve
+ # and pointing your browser at localhost:4000
-Are you new to Git or contributing on GitHub?
-We have [written a few Git tutorials](http://wiki.apache.org/cordova/ContributorWorkflow)
-to help you get started with contributing to the documentation.
+Where to make changes
+----------------------
+The files that are served by cordova.apache.org live in public/.
-### Sending Pull Requests
+"rake build" uses lesscss & jekyll to compile some files from www/ into public/
-Pull requests are welcome!
+Some files live only in public/, and changes to them should be made directly. The
+list of these can be found in _config.yml.
-We appreciate the use of topic branches.
+How to update the docs part of the website
+----------------------
- git checkout -b issue_23
+ # render the docs following the directions in the `cordova-docs` repository's README.md
- # code
+ # copy the rendered docs from `cordova-docs` to `cordova-website`
+ $ rsync -av --exclude='.svn*' public/ ../cordova-website/public/docs
- git commit -m "Issue 23: Fix a bad bug."
+ # now move to the site directory
+ $ cd ../cordova-website
- git push origin issue_23
+ # if you are adding a new version of cordova docs, don't forget to:
+ $ svn add public/docs/my_lang/my_new_version
- # send pull request from branch issue_23 to cordova:master
+ # update the "Documentation" URL on the site to point to the latest version of the docs
+ $ vi _config.yml
+ search for "Documentation"
+ change the version number in the URL to the latest (likely what you added above)
-### Adding a Language
+ # compile the site per the instructions above, since the URL to the docs changed thus the page needs to be re-generated
-Do you want the Apache Cordova documentation in another language? We do too!
-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.
-http://crowdin.net/project/cordova. For some best practices for using the
-Crowdin tool please see our wiki http://wiki.apache.org/cordova/CordovaTranslations.
+ # commit your changes to SVN
+ $ svn commit -m "Add docs version 2.5.0."
-Cordova language administrators, don't forget these steps:
-__1. config.json__
+Writing a Blog Post
+--------------------
-For each language and version, there is a `config.json` that defines the name of the language and
-how to merge the files.
+Use the grunt scripts!
-__2. Customizing HTML template__
+ # Clone apache-blog-posts repo if you haven't already
+ $ grunt cloneBlog
-Each language can override the default template in `template/docs/LANGUAGE`.
+ # Create your blog posts in the apache-blog-posts (or on github) directory, and share with other for review via `git commit`. If creating a new md file, use an earlier one as a template.
-### Editorial Guidelines
+ # pull down the latest shared edits of apache-blog-posts
+ git pull
-Please see the `STYLESHEET.md` file for guidelines on language and usage.
+ # Edit your md file to remove undesired markdown links. If there is a phrase in square brackets that isn't a CB-xxxx reference, escape it with backslashes. Otherwise, heruko might error out and fail to build all the html.
+ [CB-1234] \[iOS\] \[Camera\] add a whizzbang to the snarfblat
-## Generating Documentation with Node.js
+ # Set a marker where the summary on the home page should stop displaying. Add the following html comment line to your md file at the desired cutoff point:
+ <!--more-->
-Right now documentation could be run using Node.js either on Windows, or on Linux box.
+ # in the front matter of your blog entry, set the `date:` field to the desired date that you want to appear near the title. Be aware that the date (explicit here or implied via the filename) will be used to generate the relative path to this html file (i.e., "/announcements/2014/09/22/cordova-361.html"), as will the `categories:` front matter value.
+ date: 2014-09-22
+ categories: releases
- $ rm -r tmp public # Clear out old docs
- $ ./bin/genjs # compile all docs
- $ ./bin/genjs en edge # compile English Edge docs
- $ ./bin/genjs ru edge # compile Russian Edge docs
- $ ./bin/genjs es 3.5.0 # compile Spanish 3.5.0 docs
+ # git commit your changes to apache-blog-posts
-### Setting up Node.js
+ # copy blog www/_posts directory + linkify
+ $ grunt updateBlog
-1. Go to Node.JS [downloads page](http://nodejs.org/download/)
-2. Download and install package for your operation system.
-3. Checkout this repository using Git
+ # preview it locally
+ cd ..
+ rake build
+ rake serve
- git clone https://github.com/apache/cordova-docs
+ # add the full text of your new generate blog entry to svn
+ svn add public/announcements/2014/09/08/cordova-361.html
+ svn commit
-4. Install dependencies. In the root of the cloned cordova-docs folder run
-
- npm install
-5. Now you able to build documentation locally.
+**Types of Posts**
-### Quick Preview
+_Announcements_ - releases, call for translators, etc
-When making minor edits, it is usually safe to simply render the edited from
-Markdown to HTML. Many code editors have plugins to render Markdown to HTML
-and there are a handful of [good](http://dillinger.io/) online editors.
+_Core Content_ - If the content has to do with cordova-core, or publishing guides, etc., we should publish the full text directly on the cordova Blog (by whichever author), as-if written by the organization.
-Currently, a Node.JS script and [joDoc-js](https://github.com/kant2002/jodoc-js) are
-used to generate the HTML documentation.
+_Linked Posts_ - If the content was written by a contributor and is worth curating for the whole community, but is not really core ie. non-core plugins, dev tips, research, opinion-pieces, statistics, etc., post a short description, perhaps adding a document-snippet, but then link to the externally hosted content, making it clearly not written by the organization.
-Generating a Version Release
----------------------------
+**How to add a Post**
-There is a Rake task to increment the version, generate the version directory, and update the edge documentation.
+Blog posts live in `www/_posts`. To create a new post:
- # generate version 4.1.0 for english.
- .\bin\incrementversion en 4.1.0
+ 1. Copy one of the existing posts into a new file (changing the name appropriately).
+ 2. Run `rake serve` in the background.
+ 3. Draft your post.
+ 4. Get approval (see below)
+ 5. Update the file name to reflect the commit date (if necessary)
+ 6. Run `rake build`
+ 7. Run `www/_posts/linkify-bugs.sh so that the CB-****` turn into links
+ 8. Validate `public/rss.xml` with [http://validator.w3.org](http://validator.w3.org)
+ 9. svn commit
-QA for docs & translation
----------------------------
-In order to maintain quality of documentation and translation, following tools could be used.
+**Post guidelines:**
-1. `fixyaml` tool.
-2. `translationreport` tool.
-3. `validatejsdoc` tool.
+ * Use the post title as the first header.
+ * Including a header as well makes the snippet on the front page look bad.
+ * Use an appropriate category:
+ * One of: `howto`, `news`, `releases`, `announcements`, `blog` (the catch-all category)
+ * Use appropriate tags:
+ * `tools`, `plugins`, `android`, `ios`, `windowsphone`, `blackberry`, `plugin-$FOO`, `cli`, `performance`, `last-week`, `security` (add to this list as necessary)
+ * Use `rake serve` to preview your post, and refresh frequently.
+ * Jekyll does a poor job telling you where markdown errors exist.
+ * Use the <!--more--> tag to specify the cutoff point for displaying your post on the main page.
+ * Review your post yourself before asking for a review. This includes spell-check :).
+ * Ask for a review by pasting it into piratepad.net, and emailing the link to it to the ML.
-### FixYaml tool.
-The tool `fixyaml` created to automatically fix YAML headers in the translation files after
-exporting translated content from CrowdIn. Sometimes Crowdin messup with Apache license headers
-and this tool created to fix that.
+***Creating "last week" Posts:***
-Usage:
+To get a summary of changes (and count the changes):
+ for l in cordova-*; do ( cd $l ; git log --format="$(printf %30s $l) %s" --no-merges --since='1 week ago' ) ; done | grep -iv version | grep -v CHANGELOG > all_logs.txt
+To get the number of authors:
+ for l in cordova-*; do ( cd $l ; git log --format="%an" --no-merges --since='1 week ago' ) ; done | sort | uniq | wc -l
- bin\fixyaml # Runs fixyaml across all docs.
- bin\fixyaml ru # Runs fixyaml across all Russian docs.
- bin\fixyaml ru edge # Runs fixyaml on the latest Russian docs.
- bin\fixyaml ru 5.0.0 # Runs fixyaml on the version 5.0.0 of Russian docs.
+***Creating Release Announcement Posts***
-### Translation Report tool.
-The tool `translationreport` currently provide two QA checks for translation.
-1. It verifies that autolinking works after translation, and that translated text point to the same pages as
-in the original documentation.
-2. It verifies that translated and original files create same DOM structure, since after exporting from
-Crowdin, the markdown files could contain unnescessary lines, which lead to broken HTML, and could create
-not needed code sections for example.
+Create a copy of a previous post and update it.
-### Validate JSDoc tool.
-The tool `validatejsdoc` allow verification of the current implementation of JSDoc with reference implementation.
-It was used during porting JSDoc to the Node version of JSDoc, and now currently not used in the workflow.
+To print the list of plugin versions tested:
+ 1. Make sure all plugin repos are cloned, updated, and on master branch
+ 2. Run:
+ for d in *-plugin-*; do ( cd $d && echo "* $(basename $PWD): $(grep version plugin.xml|grep -v encoding|cut -d'"' -f2)" ) ; done | grep '^\*'
-Recommendations for the translators
--------------------------
-If you intend to create quality translation of the Cordova docs, please not only
-work in Crowdin and translate documentation, but also please go extra mile and verify that
-generated documentation for your language is also produce quality results.
-
-For that you should have Crowdin CLI tool. You could
-1. take it from [here](https://crowdin.com/page/cli-tool)
-2. or install alternate NodeJS client
-
- `npm -g install crowdin-cli`
+**Getting Approval:**
-You will use that tool for the downloading translation from Crowdin.
-To be able to download translated content from the Crowdin you should have API key for the project.
-Please ask for it on the mailing list.
+Each blog post must be approved by at least one committer other than yourself, and must be available for all to see before going live. To request a review:
-After you receive access to API key, create `crowdin.yaml` coniguration file, as described in the [CrowdIn cli tool page](https://crowdin.com/page/cli-tool).
+ 1. Run: `svn add www/_posts/your_post.md`
+ 2. Run: `post-review` [download page](http://www.reviewboard.org/docs/rbtools/dev/)
+ 3. Review it yourself, then click the `publish` button.
+ 4. Wait for someone to approve it via the `Ship it` button.
-Now you ready to download content from CrowdIn.
-Run following commands (All commands here would be for NodeJS version of Crowdin CLI)
+_Alternative steps (if post-review tool fails)_
-1. Prepare translated content for downloading.
+ 1. From the root directory, run: `svn diff > new_post.diff`
+ 2. Create a new request on http://reviews.apache.org.
+ a. Point it at your `new_post.diff` file
+ a. Set the directory to `/`
+ a. Add the group `cordova`
+ a. Click `publish`
- `crowdin-cli export`
-
- This command collect latest translations and made them available for downloading. Without that command, the translation which you would download would be stalled.
- Be careful with this command, since Crowdin implement throttling and allow you export content not faster then 1 time in 30 minutes, or so.
-2. Download content for you language. I will use Russian as example.
- `crowdin-cli download -l ru -o ru.zip`
-
- This command download all translations for Russian language to the `ru.zip` file.
-
-3. Now unpack the download content to the temporary directory.
-
- `unzip -x ru.zip -d tmp/ru`
-
-4. Copy the unpacked content to the `docs` folder.
-
- a) on Linux:
- `cp tmp/ru/cordova-docs/docs/ru/edge/* docs/ru/edge/`
-
- b) on Windows:
- `xcopy tmp/ru/cordova-docs/docs/ru/edge/* docs/ru/edge/`
-
-5. Remove temporary directory. In my case `tmp/ru`.
-
- Now you have fresh translation and could generate content.
-
-6. Fix Yaml headers by running.
-
- `bin/fixyaml ru edge`
-
-7. Run generator. You should generate both English version and language which you tranlate.
-
- ```
- bin/genjs en edge
- bin/genjs ru edge
- ```
-
- The generated documentation contains in the `public/en/edge` and `public/ru/edge`
-
- You need both versions, to validate that translated docs would have same structure as original documentation.
-
-8. Validate you translation.
-
- `bin/translationreport ru edge`
-
- This will give you list of files which has structural differences from the original docs.
- Below the example output:
- ```
- => Validating translation for version edge on language ru...
- Comparing C:\Users\kant\Documents\GitHub\cordova-docs\public\en\edge
- with C:\Users\kant\Documents\GitHub\cordova-docs\public\ru\edge
- Path guide_platforms_blackberry10_upgrade.md.html is different.
- Path guide_platforms_blackberry_upgrade.md.html is different.
- Path guide_platforms_ios_tools.md.html is different.
- Path guide_support_index.md.html is different.
- ```
-
-9. Now you could open pregenerated files and compare the English version with your translated versions.
- Open both versions and find out what's wrong.
-
- If on the first sight you could not find the differences, you could add switch `-v` which will increase verbosity of the tool.
- For example:
-
- `bin/translationreport ru edge -v`
-
-10. Currently there two type of errors reported:
-
- a. Missing or additional links.
-
- b. The broken HTML structure.
-
-11. Let's fix first type of errors - Missing/Additional links.
- To fix these type of errors you have to make sure that text in your translation where you want to have link,
- match exactly the header in the translated document, otherwise auto-linking would not work.
- You have to rephrase the sentences to fix that.
-
-12. Broken HTML DOM structure.
+How to deploy the website
+-------------------------
- Most likely this type of errors caused by the additional lines created by Crowdin during export.
- You have to manually spot these places and remove additional lines when needed and then commit your changes to Git.
- Most likely these erorrs reappear after next exprot from CrowdIn, so don't hunt for these errors until release, or create
- tool which will fix these error after each export and use it.
-
-13. Now you ready to create pull request with documentation to the main `crodova-docs` repository.
+- the website is automatically updated on each commit.
+- the website should update within seconds.
-Enjoy translation!!!
\ No newline at end of file
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/fcb4d7c1/STYLESHEET.md
----------------------------------------------------------------------
diff --git a/STYLESHEET.md b/STYLESHEET.md
deleted file mode 100644
index e795bcb..0000000
--- a/STYLESHEET.md
+++ /dev/null
@@ -1,408 +0,0 @@
----
-license: Licensed to the Apache Software Foundation (ASF) under one
- or more contributor license agreements. See the NOTICE file
- distributed with this work for additional information
- regarding copyright ownership. The ASF licenses this file
- to you under the Apache License, Version 2.0 (the
- "License"); you may not use this file except in compliance
- with the License. You may obtain a copy of the License at
-
- http://www.apache.org/licenses/LICENSE-2.0
-
- Unless required by applicable law or agreed to in writing,
- software distributed under the License is distributed on an
- "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
- KIND, either express or implied. See the License for the
- specific language governing permissions and limitations
- under the License.
----
-
-# Editorial Style Sheet
-
-Developers contributing to Cordova are already familiar with coding
-best practices. What you'll find here are best practices when writing
-tech doc addressed to Cordova developers. A consistent set of
-standards helps tie together doc, and makes it seem like it's written
-with one voice.
-
-There are two basic kinds of tech doc: reference content and
-expository "guide" content. Reference doc tends to be self-contained,
-descriptive, and scoped without context: e.g., detailing an API
-interface and its members. Guide content is prescriptive, linear, and
-part of a larger story. How do you typically use the API (or
-whatever), what do you need to know first, what are the limits to what
-you can use it for, etc. Guide content is oriented more around tasks,
-common use cases, or especially now in Cordova's case, alternative
-workflows. It may not be obvious, but if you first ask yourself what
-purpose the doc you're editing serves, it improves its quality
-immensely.
-
-These guidelines are not necessarily set in stone. If you think of
-alternatives or exceptions, please note them here. Some of the issues
-identified below are listed along with recursive `grep` commands to
-help identify them in Markdown.
-
-## Structure and Flow
-
-* __Provide Context__: Each page of expository doc should start with a
- short paragraph summarizing the subject matter, and serving as
- necessary connective tissue to other doc. Link to other related &
- prerequisite topics, especially for likely workflow scenarios.
- E.g., Plugman doc is most appropriate for platform-specific
- shell-tool workflow, not for the CLI even though it underlies it
- invisibly.
-
-* __Valid Heading Structure__: One title only (an A-head) at the top
- of the page. No jumps to C-heads. Do not follow a heading with a
- subheading with no intervening introductory text.
-
- grep -hr '^#' * # Lists all headings; use '#' prefixes rather than underlines
-
-* __Flatten Content__: Use B-heads to divide each page's content. Please
- avoid C-heads. Readers tend to lose context once content gets that
- nested. Think: "blog post."
-
- grep -hr '^###' * # Identifies C-heads
-
-* __Consistent Headings__: Try to match verb tense in headings. That
- is, if one is task-based and reads "Adding a Platform," the other
- should be "Developing for Android" rather than "Android Development"
-
-* __Heading Content__: In reference doc, preserve case in titles and
- headings. In guide doc: Initial Cap Words in Headings, Except for
- Short Prepositions or Conjunctions. Also Init-Cap Around Hyphens. No
- punctuation at the end of a heading, and avoid punctuation within
- headings. Do not prefix headings with numbers.
-
- grep -hr '^#' * | sed 's/^#*//g' | grep '[^A-Za-z0-9 ]'
-
-* __Heading Fonts__: In reference doc, do not apply font formatting to
- standalone member names such as compass.getCurrentHeading. Minimize
- font changes within headings. If necessary, only apply italic.
-
-* __Listings__: Use numbered lists for sequential procedures or ranked
- content only, otherwise use bullet lists. Precede lists with text
- that introduces them, preferably ending with a colon (:). Do not
- allow single-item lists. Use bullet lists only to indicate a clear
- set of choices that you first introduce, not as a substitute for a
- series of regular paragraphs. Avoid nested lists, for the same
- reason you avoid C-heads. Do not indent top-level lists.
-
-* __Punctuating and Formatting Lists__: Append periods to bullet and
- number list items that consist of full sentences. No periods when
- bullet items are sentence fragments, except in bullet lists that
- need internal consistency. To improve readability, add vertical
- space around top-level bullet/numbered list items that consist of
- full sentences. OK to vertically collapse lists of short, easily
- scannable items.
-
-* __Procedure Lists__: Don't break out separate procedure items for
- (1) do this, followed by (2) this describes what just happened, then
- (3) do that. Prefer (1) Do this. It does so-and-so, which you might
- see in some result. (2) Do that...
-
-* __Topic/Comment Lists__: For bullet lists that provide short topics
- followed by comments, bold the topic, then merge the comment on the
- same line, separated with a colon unless the topic features trailing
- punctuation. This list item provides an example. Bolded Topic Text
- Follows Same Init-Cap Rule as Headings.
-
-* __Notes__: Bold and all-cap __NOTE__:, with colon outside, always at
- the start of a paragraph, never mid-paragraph. Do not incorporate
- this font change into a sentence as in "__Note__ that..." but OK to
- start a sentence: "Note that..." when the information is less
- consequential. Do not apply bullet/number list formatting.
-
- grep -hr ':__' *
- grep -hr ' __NOTE' *
- grep -hr 'Note:' *
-* __Warnings/Tips__: As an alternative to __NOTE__:, use __WARNING__:
- for serious matters, or __TIP__: to pass along useful tricks or
- context.
-
- grep -hri 'Tip:' *
- grep -hri 'Warning:' *
-
-* __Minimize Notes__: Avoid too many notes and warnings, as it implies
- a haphazard development environment with too many variable factors
- that divert the reader's attention. Try to clarify variations on a
- procedure within the text. Try to focus attention on information
- specific to Cordova, not on background knowledge.
-
-## Language and Tone
-
-* __Not So Imperative__: As a rule of thumb, avoid the word "must" and
- unnecessarily imperative statements in general. E.g., instead of
- "Commands must be run from a cmd or powershell prompt," try "You can
- run commands either from a cmd or powershell prompt."
-
- grep -hri '\<must\>' *
- grep -r '\<requires*\>' *
-
-* __Avoid the Willies__: Use present tense. "This happens," not "this
- will happen." Future tense comes off as a tenuous prediction. Rule
- of thumb: avoid the word "will."
-
- grep -hri '\<will\>' *
-
-* __Avoid Passive Voice__: Past-tense passive voice is to be avoided.
- E.g., "the pause event fires when..." rather than "the pause event
- is fired when..." Rule of thumb: banish verbs ending in "ed".
- Passive voice is more appropriate for reference doc, you should
- still avoid it when there's a better active-voice alternative.
-
- grep -hr '\<is [a-z]*ed\>' *
- grep -hr '\<be [a-z]*ed\>' *
- grep -hr '\<was [a-z]*ed\>' *
-
-* __Not Kidding, Use Present Tense__: Minimize verbs ending with
- "ing": "This is necessary to provide...", not "This is necessary for
- providing..." <!-- are\s-+[a-z]+ing\b -->
-
- grep -hr '\<for [a-z]*ing\>' *
- grep -hr '\<by [a-z]*ing\>' *
-
-* __Use Action Verbs__: Avoid weak verbs like "is" or "has." The
- sentence in the item above could stand improvement.
-
-* __Noun Phrase Jargon__: Avoid noun modification concatenation
- somnambulation obfuscation. Use your judgement and ask yourself if
- readers might not actually know what some noun phrase means. If so,
- explain the actual concept it represents, in this case: "Avoid
- stringing nouns together into long phrases that come off as
- impenetrable shop talk that puts everybody to sleep."
-
-* __Use Possessives__: Possessives sound more familiar and colloquial:
- "the device's home screen" rather than clumsier: "the home screen of
- the device"
-
- grep -hr '\<of the\>' *
-
-* __The Brothers Karmazov__: 'The FOO file', not 'the file FOO', no
- matter how long FOO's path is. Rule of thumb: would you say it when
- speaking out loud?
-
-* __Serial comma__: This, that, and the other.
-
-* Do not drop articles: "In the Bada IDE", not "In Bada IDE"
-
-* Do not start a sentence with a lowercase member name. E.g., "Does
- not support `filter`" rather than "`filter` is not supported"
-
- grep -hr '\. `' *
-
-* Do not refer to "I," the author of the documentation, as in "What I
- am going to show you now." Likewise avoid "we" and "let's," so
- instead of "We see that..." try "You see that" or "Note that..."
- Readers want to focus on whatever they're working on, not on you.
-
- grep -hr '\<I\>' *
-
-* OK to refer to "you," the developer, but only sparingly, e.g., to
- avoid the passive voice. Also do not use "your" as a routine
- substitute for "the" or "a" when referring to a noun.
-
- grep -hri '\<your*\>' *
-
-* Avoid em dash clauses--they unnecessarily break up the text--and
- parenthical statements (which can also be distracting). If you do
- include either, remove spaces around the dashes (punctuate fragments
- outside of paren's). (Punctuate full sentences inside of parens.)
-
-* Refer to this Guide or section, not this document, page, or anything
- else.
-
-## In-line Font Formatting
-
-* Use `monospace` for all-purpose nouns used in programming, e.g.: API
- interfaces, methods, properties, literal values, Unix commands,
- pathnames, filenames, etc.
-
-* Use __bold__ for on-screen items, such as the names of menu items,
- buttons, and check boxes.
-
-* Use _italics_ for emphasis, simple mathematical expressions, and
- variable items (e.g., _x_/_y_ coordinates).
-
-* Do _not_ use ALL CAPS for emphasis. (Exception: in code comments)
-
-* Do _not_ use "quote characters" to deliniate in-line text unless
- required as part of a value. E.g., not OK to refer to the
- "text-align" property. OK to set the CSS `text-align` property to
- `left`, and the `content` property to `"This is some quoted text."`
- (Exception: within code comments)
-
-* Do not combine in-line formatting such as _`monospace italic`_.
-
-* Use the markup system's shorthand characters rather than embedded
- HTML `<em>...</em>` or `<code>...</code>`.
-
-## Usage
-
-* "User" may refer to the end user, not to an application's
- "developer" who is presumably reading the doc. Refer to plural
- "users" as "they" to avoid singular he/she pronoun problems. Also
- avoid "his" and "her". <!--RE\bs?he\b--> <!--RE\b(his|her)\b-->
-
- grep -hri '\<s*he\>' *
- grep -hri '\<his\>' *
- grep -hri '\<her\>' *
-
-* WebView, not Webview. (OK to use lowercase webview in code)
-
-* "In-line" rather than "inline" in ordinary text, e.g., outside of
- technical terms.
-
-* "Plugman" in generic references, `plugman` when referring to the
- actual utility as invoked on the command line.
-
-* metadata.
-
-* Xcode.
-
-* "splash screen" unless specifically referring to the name of the API.
-
-* 'Directory', not 'folder'; may be exceptions in some GUI contexts.
-
-* Prefer "can't" over "cannot"; sounds more relaxed.
-
-* Subdirectory, not sub-directory
-
-* 'Press' a button on the screen; 'type' a key; do not 'hit' either.
-
-* 'Set up' as verb, 'setup' as noun.
-
-* 'handheld' not 'hand held' or 'hand-held'
-
-* Filename, not file name
-
-* 'JavaScript' (but lowercase when MIME type)
-
-* Unix, not unix
-
-* Mac "OS X", not "OSX"
-
-* BlackBerry, not Blackberry
-
-* "BlackBerry 10," not "BlackBerry10"
-
-* Prefer "emulator" over "simulator"; clarify when interfaces refer to
- them differently.
-
-* Use "app" for mobile apps, and "application" for presumably more
- complex desktop affairs. E.g., you may use the Xcode application to
- help you write an iOS Cordova app. Consider "app" a valid word
- rather than a contraction, so use "apps" rather than "app's" as
- plural.
-
-* Likewise, "repo" is OK to substitute for "repository"
-
-* Prefer generic "SDK" over "IDE", or "SDK tools" when referring to
- dedicated GUI coding environments such as Eclipse. (OK to refer to
- specific tools as IDEs if that's how they self-identify.)
-
-* Remove superfluous "navigate to" wherever possible, unless you need
- to `cd` to a particular directory to launch a command. Instead of
- "Navigate to the `D` directory and edit the `F` file," prefer: "Edit
- the `D/F` file." And don't tell people which text editor to use.
- That's fascist.
-
-* An XML/HTML 'element' rather than 'tag'
-
-* Without getting into any pointless arguments about object-oriented
- programming, it's a "method" when called on an object. Refer to
- "function" only when unspecified, e.g. you can implement a "callback
- function" as an object method, but not necessarily.
-
-* Use parentheses when referring to `method()` and `function()` names.
- (Exception: when assigning a reference to the object rather than
- calling it as a method.)
-
-* Spell out "and" and "or"; do not substitute with "&" or "/" within
- text.
-
-* "and/or" is unnecessary; "or" usually makes that implicit.
-
-* Avoid unnecessary/gratuitous slash-delimited alternators in text, as
- in this example (but OK to refer to try/catch blocks).
-
-* Avoid trailing (s) to denote optional plural. It's usually implicit.
- E.g., "return information about any captured image files", not
- "file(s)"
-
-* Avoid the word "multiple" wherever possible. It's one of those
- unnecessary words up there with "myriad" or "plethora." What ever
- happened to "several"?
-
-## Punctuation
-
-* Append colon to text that introduces a code snippet or image.
-
-* Use `&rarr;` arrow entities (→) for hierarchical menus or
- sequences of nested dialog boxes.
-
-## Common Grammatical Errors
-
-* __Hyphenate Adjective Phrases__: E.g., "command-line tools", but not
- when it's a noun, as in "the command line."
-
-* __It's a Crazy Language, but its Rules Eventually Make Sense__:
- Hyphenate "it's" only for "it is," not for possessive.
-
-* __Plural Possessives__: E.g., Obtain a user's permission, but
- collectively, get users' permission.
-
-* Do not use apostrophes for plural, so "...manages core APIs,"
- not api's or API's. Only use apostrophes for possessives, e.g. "the
- API's members"
-
-* "applications" not "app's" for plural
-
-* Do not hyphenate adverbs, as it's implict they modify verbs. So,
- "commonly seen problems," not "commonly-seen problems"
-
-* Use semicolons to separate short, closely related clauses that can
- stand alone grammatically as full sentences. Use commas to separate
- clauses where one is a sentence fragment. E.g., "This is a clause,
- along with this." vs. "This can serve as a sentence; this can too."
-
-* If a sentence with semicolons runs on too long, it's time to break
- it out into separate sentences. Rewrite this... "This can serve as
- a sentence; this can too, along with related information." ...as...
- "This can serve as a sentence. This can too, along with related
- information."
-
-* This can serve as a sentence and this can also serve as a sentence
- but you need to use commas to separate this big mess.
-
-## Content-specific
-
-* Refer to the default app as "Hello World", regardless of what it
- actually displays.
-
-* Refer to the default plugin demo as "Echo"
-
-* Keep the term "hybrid" app confined to two scenarios: (1) an app
- whose developer has to supply components that bridge native &
- webview, e.g., custom plugins, or an embedded webview component. (2)
- An app with an InAppBrowser, that is a web-based app that itself
- opens a web page. Don't apply to a garden-variety "cross-platform"
- app that is Cordova's bread and butter.
-
-## Links
-
-* Use titles in link text, never 'click here'. Consider using the
- link's domain name as a substitute.
-
-* Domain names are OK as a link's display text, but not full
- scheme-qualified URLs. No bare URLs in text outside of code.
-
- grep -hr '\[http' *
-
-## Miscellaneous
-
-* OK to use shorthand notation for version ranges, e.g. "5.0+" rather
- than "(OS 5.0 and higher)"
-
-* Use space characters rather than tabs in code blocks.
-
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/fcb4d7c1/_config.yml
----------------------------------------------------------------------
diff --git a/_config.yml b/_config.yml
new file mode 100644
index 0000000..59e117c
--- /dev/null
+++ b/_config.yml
@@ -0,0 +1,42 @@
+# =======
+# Site settings
+# =======
+title: Apache Cordova
+description: Apache Cordova is a set of device APIs that allow a web mobile app developer to access native device function from JavaScript.
+url: "http://cordova.apache.org" # the base hostname & protocol
+baseurl: "" # the subpath of the site, e.g. /blog/
+rss_path: /feed.xml
+
+# NOTE: defaults are configured in _defaults.yml, which is a generated file
+
+# =======
+# Build settings
+# =======
+source: www
+destination: public
+
+keep_files: ['.git', '.svn', 'docs', 'wiki-images', 'static', 'images', 'downloads']
+
+lsi: false
+safe: true
+highlighter: pygments
+
+markdown: rdiscount
+rdiscount:
+ extensions:
+ - autolink
+ - footnotes
+ - smart
+
+# exclude:
+# - docs/de/
+# - docs/en/
+# - docs/es/
+# - docs/fr/
+# - docs/it/
+# - docs/ja/
+# - docs/ko/
+# - docs/pl/
+# - docs/ru/
+# - docs/sl/
+# - docs/zh/
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/fcb4d7c1/doc/STYLEGUIDE.md
----------------------------------------------------------------------
diff --git a/doc/STYLEGUIDE.md b/doc/STYLEGUIDE.md
new file mode 100644
index 0000000..e795bcb
--- /dev/null
+++ b/doc/STYLEGUIDE.md
@@ -0,0 +1,408 @@
+---
+license: Licensed to the Apache Software Foundation (ASF) under one
+ or more contributor license agreements. See the NOTICE file
+ distributed with this work for additional information
+ regarding copyright ownership. The ASF licenses this file
+ to you under the Apache License, Version 2.0 (the
+ "License"); you may not use this file except in compliance
+ with the License. You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing,
+ software distributed under the License is distributed on an
+ "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ KIND, either express or implied. See the License for the
+ specific language governing permissions and limitations
+ under the License.
+---
+
+# Editorial Style Sheet
+
+Developers contributing to Cordova are already familiar with coding
+best practices. What you'll find here are best practices when writing
+tech doc addressed to Cordova developers. A consistent set of
+standards helps tie together doc, and makes it seem like it's written
+with one voice.
+
+There are two basic kinds of tech doc: reference content and
+expository "guide" content. Reference doc tends to be self-contained,
+descriptive, and scoped without context: e.g., detailing an API
+interface and its members. Guide content is prescriptive, linear, and
+part of a larger story. How do you typically use the API (or
+whatever), what do you need to know first, what are the limits to what
+you can use it for, etc. Guide content is oriented more around tasks,
+common use cases, or especially now in Cordova's case, alternative
+workflows. It may not be obvious, but if you first ask yourself what
+purpose the doc you're editing serves, it improves its quality
+immensely.
+
+These guidelines are not necessarily set in stone. If you think of
+alternatives or exceptions, please note them here. Some of the issues
+identified below are listed along with recursive `grep` commands to
+help identify them in Markdown.
+
+## Structure and Flow
+
+* __Provide Context__: Each page of expository doc should start with a
+ short paragraph summarizing the subject matter, and serving as
+ necessary connective tissue to other doc. Link to other related &
+ prerequisite topics, especially for likely workflow scenarios.
+ E.g., Plugman doc is most appropriate for platform-specific
+ shell-tool workflow, not for the CLI even though it underlies it
+ invisibly.
+
+* __Valid Heading Structure__: One title only (an A-head) at the top
+ of the page. No jumps to C-heads. Do not follow a heading with a
+ subheading with no intervening introductory text.
+
+ grep -hr '^#' * # Lists all headings; use '#' prefixes rather than underlines
+
+* __Flatten Content__: Use B-heads to divide each page's content. Please
+ avoid C-heads. Readers tend to lose context once content gets that
+ nested. Think: "blog post."
+
+ grep -hr '^###' * # Identifies C-heads
+
+* __Consistent Headings__: Try to match verb tense in headings. That
+ is, if one is task-based and reads "Adding a Platform," the other
+ should be "Developing for Android" rather than "Android Development"
+
+* __Heading Content__: In reference doc, preserve case in titles and
+ headings. In guide doc: Initial Cap Words in Headings, Except for
+ Short Prepositions or Conjunctions. Also Init-Cap Around Hyphens. No
+ punctuation at the end of a heading, and avoid punctuation within
+ headings. Do not prefix headings with numbers.
+
+ grep -hr '^#' * | sed 's/^#*//g' | grep '[^A-Za-z0-9 ]'
+
+* __Heading Fonts__: In reference doc, do not apply font formatting to
+ standalone member names such as compass.getCurrentHeading. Minimize
+ font changes within headings. If necessary, only apply italic.
+
+* __Listings__: Use numbered lists for sequential procedures or ranked
+ content only, otherwise use bullet lists. Precede lists with text
+ that introduces them, preferably ending with a colon (:). Do not
+ allow single-item lists. Use bullet lists only to indicate a clear
+ set of choices that you first introduce, not as a substitute for a
+ series of regular paragraphs. Avoid nested lists, for the same
+ reason you avoid C-heads. Do not indent top-level lists.
+
+* __Punctuating and Formatting Lists__: Append periods to bullet and
+ number list items that consist of full sentences. No periods when
+ bullet items are sentence fragments, except in bullet lists that
+ need internal consistency. To improve readability, add vertical
+ space around top-level bullet/numbered list items that consist of
+ full sentences. OK to vertically collapse lists of short, easily
+ scannable items.
+
+* __Procedure Lists__: Don't break out separate procedure items for
+ (1) do this, followed by (2) this describes what just happened, then
+ (3) do that. Prefer (1) Do this. It does so-and-so, which you might
+ see in some result. (2) Do that...
+
+* __Topic/Comment Lists__: For bullet lists that provide short topics
+ followed by comments, bold the topic, then merge the comment on the
+ same line, separated with a colon unless the topic features trailing
+ punctuation. This list item provides an example. Bolded Topic Text
+ Follows Same Init-Cap Rule as Headings.
+
+* __Notes__: Bold and all-cap __NOTE__:, with colon outside, always at
+ the start of a paragraph, never mid-paragraph. Do not incorporate
+ this font change into a sentence as in "__Note__ that..." but OK to
+ start a sentence: "Note that..." when the information is less
+ consequential. Do not apply bullet/number list formatting.
+
+ grep -hr ':__' *
+ grep -hr ' __NOTE' *
+ grep -hr 'Note:' *
+* __Warnings/Tips__: As an alternative to __NOTE__:, use __WARNING__:
+ for serious matters, or __TIP__: to pass along useful tricks or
+ context.
+
+ grep -hri 'Tip:' *
+ grep -hri 'Warning:' *
+
+* __Minimize Notes__: Avoid too many notes and warnings, as it implies
+ a haphazard development environment with too many variable factors
+ that divert the reader's attention. Try to clarify variations on a
+ procedure within the text. Try to focus attention on information
+ specific to Cordova, not on background knowledge.
+
+## Language and Tone
+
+* __Not So Imperative__: As a rule of thumb, avoid the word "must" and
+ unnecessarily imperative statements in general. E.g., instead of
+ "Commands must be run from a cmd or powershell prompt," try "You can
+ run commands either from a cmd or powershell prompt."
+
+ grep -hri '\<must\>' *
+ grep -r '\<requires*\>' *
+
+* __Avoid the Willies__: Use present tense. "This happens," not "this
+ will happen." Future tense comes off as a tenuous prediction. Rule
+ of thumb: avoid the word "will."
+
+ grep -hri '\<will\>' *
+
+* __Avoid Passive Voice__: Past-tense passive voice is to be avoided.
+ E.g., "the pause event fires when..." rather than "the pause event
+ is fired when..." Rule of thumb: banish verbs ending in "ed".
+ Passive voice is more appropriate for reference doc, you should
+ still avoid it when there's a better active-voice alternative.
+
+ grep -hr '\<is [a-z]*ed\>' *
+ grep -hr '\<be [a-z]*ed\>' *
+ grep -hr '\<was [a-z]*ed\>' *
+
+* __Not Kidding, Use Present Tense__: Minimize verbs ending with
+ "ing": "This is necessary to provide...", not "This is necessary for
+ providing..." <!-- are\s-+[a-z]+ing\b -->
+
+ grep -hr '\<for [a-z]*ing\>' *
+ grep -hr '\<by [a-z]*ing\>' *
+
+* __Use Action Verbs__: Avoid weak verbs like "is" or "has." The
+ sentence in the item above could stand improvement.
+
+* __Noun Phrase Jargon__: Avoid noun modification concatenation
+ somnambulation obfuscation. Use your judgement and ask yourself if
+ readers might not actually know what some noun phrase means. If so,
+ explain the actual concept it represents, in this case: "Avoid
+ stringing nouns together into long phrases that come off as
+ impenetrable shop talk that puts everybody to sleep."
+
+* __Use Possessives__: Possessives sound more familiar and colloquial:
+ "the device's home screen" rather than clumsier: "the home screen of
+ the device"
+
+ grep -hr '\<of the\>' *
+
+* __The Brothers Karmazov__: 'The FOO file', not 'the file FOO', no
+ matter how long FOO's path is. Rule of thumb: would you say it when
+ speaking out loud?
+
+* __Serial comma__: This, that, and the other.
+
+* Do not drop articles: "In the Bada IDE", not "In Bada IDE"
+
+* Do not start a sentence with a lowercase member name. E.g., "Does
+ not support `filter`" rather than "`filter` is not supported"
+
+ grep -hr '\. `' *
+
+* Do not refer to "I," the author of the documentation, as in "What I
+ am going to show you now." Likewise avoid "we" and "let's," so
+ instead of "We see that..." try "You see that" or "Note that..."
+ Readers want to focus on whatever they're working on, not on you.
+
+ grep -hr '\<I\>' *
+
+* OK to refer to "you," the developer, but only sparingly, e.g., to
+ avoid the passive voice. Also do not use "your" as a routine
+ substitute for "the" or "a" when referring to a noun.
+
+ grep -hri '\<your*\>' *
+
+* Avoid em dash clauses--they unnecessarily break up the text--and
+ parenthical statements (which can also be distracting). If you do
+ include either, remove spaces around the dashes (punctuate fragments
+ outside of paren's). (Punctuate full sentences inside of parens.)
+
+* Refer to this Guide or section, not this document, page, or anything
+ else.
+
+## In-line Font Formatting
+
+* Use `monospace` for all-purpose nouns used in programming, e.g.: API
+ interfaces, methods, properties, literal values, Unix commands,
+ pathnames, filenames, etc.
+
+* Use __bold__ for on-screen items, such as the names of menu items,
+ buttons, and check boxes.
+
+* Use _italics_ for emphasis, simple mathematical expressions, and
+ variable items (e.g., _x_/_y_ coordinates).
+
+* Do _not_ use ALL CAPS for emphasis. (Exception: in code comments)
+
+* Do _not_ use "quote characters" to deliniate in-line text unless
+ required as part of a value. E.g., not OK to refer to the
+ "text-align" property. OK to set the CSS `text-align` property to
+ `left`, and the `content` property to `"This is some quoted text."`
+ (Exception: within code comments)
+
+* Do not combine in-line formatting such as _`monospace italic`_.
+
+* Use the markup system's shorthand characters rather than embedded
+ HTML `<em>...</em>` or `<code>...</code>`.
+
+## Usage
+
+* "User" may refer to the end user, not to an application's
+ "developer" who is presumably reading the doc. Refer to plural
+ "users" as "they" to avoid singular he/she pronoun problems. Also
+ avoid "his" and "her". <!--RE\bs?he\b--> <!--RE\b(his|her)\b-->
+
+ grep -hri '\<s*he\>' *
+ grep -hri '\<his\>' *
+ grep -hri '\<her\>' *
+
+* WebView, not Webview. (OK to use lowercase webview in code)
+
+* "In-line" rather than "inline" in ordinary text, e.g., outside of
+ technical terms.
+
+* "Plugman" in generic references, `plugman` when referring to the
+ actual utility as invoked on the command line.
+
+* metadata.
+
+* Xcode.
+
+* "splash screen" unless specifically referring to the name of the API.
+
+* 'Directory', not 'folder'; may be exceptions in some GUI contexts.
+
+* Prefer "can't" over "cannot"; sounds more relaxed.
+
+* Subdirectory, not sub-directory
+
+* 'Press' a button on the screen; 'type' a key; do not 'hit' either.
+
+* 'Set up' as verb, 'setup' as noun.
+
+* 'handheld' not 'hand held' or 'hand-held'
+
+* Filename, not file name
+
+* 'JavaScript' (but lowercase when MIME type)
+
+* Unix, not unix
+
+* Mac "OS X", not "OSX"
+
+* BlackBerry, not Blackberry
+
+* "BlackBerry 10," not "BlackBerry10"
+
+* Prefer "emulator" over "simulator"; clarify when interfaces refer to
+ them differently.
+
+* Use "app" for mobile apps, and "application" for presumably more
+ complex desktop affairs. E.g., you may use the Xcode application to
+ help you write an iOS Cordova app. Consider "app" a valid word
+ rather than a contraction, so use "apps" rather than "app's" as
+ plural.
+
+* Likewise, "repo" is OK to substitute for "repository"
+
+* Prefer generic "SDK" over "IDE", or "SDK tools" when referring to
+ dedicated GUI coding environments such as Eclipse. (OK to refer to
+ specific tools as IDEs if that's how they self-identify.)
+
+* Remove superfluous "navigate to" wherever possible, unless you need
+ to `cd` to a particular directory to launch a command. Instead of
+ "Navigate to the `D` directory and edit the `F` file," prefer: "Edit
+ the `D/F` file." And don't tell people which text editor to use.
+ That's fascist.
+
+* An XML/HTML 'element' rather than 'tag'
+
+* Without getting into any pointless arguments about object-oriented
+ programming, it's a "method" when called on an object. Refer to
+ "function" only when unspecified, e.g. you can implement a "callback
+ function" as an object method, but not necessarily.
+
+* Use parentheses when referring to `method()` and `function()` names.
+ (Exception: when assigning a reference to the object rather than
+ calling it as a method.)
+
+* Spell out "and" and "or"; do not substitute with "&" or "/" within
+ text.
+
+* "and/or" is unnecessary; "or" usually makes that implicit.
+
+* Avoid unnecessary/gratuitous slash-delimited alternators in text, as
+ in this example (but OK to refer to try/catch blocks).
+
+* Avoid trailing (s) to denote optional plural. It's usually implicit.
+ E.g., "return information about any captured image files", not
+ "file(s)"
+
+* Avoid the word "multiple" wherever possible. It's one of those
+ unnecessary words up there with "myriad" or "plethora." What ever
+ happened to "several"?
+
+## Punctuation
+
+* Append colon to text that introduces a code snippet or image.
+
+* Use `&rarr;` arrow entities (→) for hierarchical menus or
+ sequences of nested dialog boxes.
+
+## Common Grammatical Errors
+
+* __Hyphenate Adjective Phrases__: E.g., "command-line tools", but not
+ when it's a noun, as in "the command line."
+
+* __It's a Crazy Language, but its Rules Eventually Make Sense__:
+ Hyphenate "it's" only for "it is," not for possessive.
+
+* __Plural Possessives__: E.g., Obtain a user's permission, but
+ collectively, get users' permission.
+
+* Do not use apostrophes for plural, so "...manages core APIs,"
+ not api's or API's. Only use apostrophes for possessives, e.g. "the
+ API's members"
+
+* "applications" not "app's" for plural
+
+* Do not hyphenate adverbs, as it's implict they modify verbs. So,
+ "commonly seen problems," not "commonly-seen problems"
+
+* Use semicolons to separate short, closely related clauses that can
+ stand alone grammatically as full sentences. Use commas to separate
+ clauses where one is a sentence fragment. E.g., "This is a clause,
+ along with this." vs. "This can serve as a sentence; this can too."
+
+* If a sentence with semicolons runs on too long, it's time to break
+ it out into separate sentences. Rewrite this... "This can serve as
+ a sentence; this can too, along with related information." ...as...
+ "This can serve as a sentence. This can too, along with related
+ information."
+
+* This can serve as a sentence and this can also serve as a sentence
+ but you need to use commas to separate this big mess.
+
+## Content-specific
+
+* Refer to the default app as "Hello World", regardless of what it
+ actually displays.
+
+* Refer to the default plugin demo as "Echo"
+
+* Keep the term "hybrid" app confined to two scenarios: (1) an app
+ whose developer has to supply components that bridge native &
+ webview, e.g., custom plugins, or an embedded webview component. (2)
+ An app with an InAppBrowser, that is a web-based app that itself
+ opens a web page. Don't apply to a garden-variety "cross-platform"
+ app that is Cordova's bread and butter.
+
+## Links
+
+* Use titles in link text, never 'click here'. Consider using the
+ link's domain name as a substitute.
+
+* Domain names are OK as a link's display text, but not full
+ scheme-qualified URLs. No bare URLs in text outside of code.
+
+ grep -hr '\[http' *
+
+## Miscellaneous
+
+* OK to use shorthand notation for version ranges, e.g. "5.0+" rather
+ than "(OS 5.0 and higher)"
+
+* Use space characters rather than tabs in code blocks.
+
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/fcb4d7c1/package.json
----------------------------------------------------------------------
diff --git a/package.json b/package.json
index 00b3c3f..87a2b91 100644
--- a/package.json
+++ b/package.json
@@ -1,17 +1,25 @@
{
- "name": "cordova-docs",
- "version": "4.0.1-dev",
- "description": "Documentation for the Apache Cordova",
- "main": "index.js",
+ "name": "cordova-website",
+ "version": "0.0.1",
+ "description": "website for cordova.apache.org",
+ "main": "echo \"not specified\" && exit 1",
"directories": {
- "doc": "docs"
+ "doc": "doc"
},
+ "scripts": {
+ "jshint": "node node_modules/jshint/bin/jshint lib spec",
+ "test": "npm run jshint && npm run mocha",
+ "mocha": "./node_modules/.bin/mocha --recursive ./spec"
+ },
+ "author": "Apache Software Foundation",
+ "license": "Apache Version 2.0",
"dependencies": {
"cheerio": "^0.17.0",
"esrever": "^0.1.0",
"fs-extra": "^0.11.1",
"jodoc": "git://github.com/kant2002/jodoc-js",
"js-yaml": "^3.2.2",
+ "less": "^2.5.1",
"node-dir": "^0.1.6",
"shelljs": "^0.3.0",
"yargs": "^1.3.1"
@@ -20,21 +28,17 @@
"colors": "^1.0.3",
"diff": "^1.2.0",
"jshint": "^2.5.8",
- "mocha": "^1.21.4"
- },
- "scripts": {
- "jshint": "node node_modules/jshint/bin/jshint lib spec",
- "test": "npm run jshint && npm run mocha",
- "mocha": "./node_modules/.bin/mocha --recursive ./spec"
+ "mocha": "^1.21.4",
+ "grunt": "^0.4.5",
+ "grunt-shell": "^0.7.0",
+ "grunt-xmllint": "^0.1.1"
},
"repository": {
"type": "git",
- "url": "https://github.com/apache/cordova-docs.git"
+ "url": "https://github.com/apache/cordova-website.git"
},
- "author": "",
- "license": "ISC",
"bugs": {
- "url": "https://github.com/apache/cordova-docs/issues"
+ "url": "https://github.com/apache/cordova-website/issues"
},
- "homepage": "https://github.com/apache/cordova-docs"
+ "homepage": "https://cordova.apache.org"
}
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/fcb4d7c1/www/_data/index-config.yml
----------------------------------------------------------------------
diff --git a/www/_data/index-config.yml b/www/_data/index-config.yml
new file mode 100644
index 0000000..3865f2e
--- /dev/null
+++ b/www/_data/index-config.yml
@@ -0,0 +1,319 @@
+releases:
+ version: "5.1.1"
+ directory: "https://www.apache.org/dist/cordova/"
+ note: "Apache Cordova 5.1.1"
+
+sitemap: {
+ "about": {
+ "title": "About Cordova",
+ "url": "/index.html#about"
+ },
+ "artwork": {
+ "title": "Artwork",
+ "url": "/artwork.html"
+ },
+ "download": {
+ "title": "Download",
+ "url": "/index.html#download"
+ },
+ "mailing-list": {
+ "title": "Mailing List",
+ "url": "/index.html#mailing-list"
+ },
+ "docs": {
+ "title": "Documentation",
+ "url": "http://cordova.apache.org/docs/en/5.0.0/"
+ },
+ "general": [
+ {
+ "title": "Apache Project Page",
+ "url": "http://projects.apache.org/projects/cordova.html"
+ },
+ {
+ "title": "License",
+ "url": "http://www.apache.org/licenses/LICENSE-2.0"
+ }
+ ],
+ "dev": [
+ {
+ "title": "Source Code",
+ "url": "https://git-wip-us.apache.org/repos/asf"
+ },
+ {
+ "title": "Issue Tracker",
+ "url": "https://issues.apache.org/jira/browse/CB"
+ },
+ {
+ "title": "Wiki",
+ "url": "http://wiki.apache.org/cordova/"
+ }
+ ],
+ "asf": [
+ {
+ "title": "About ASF",
+ "url": "http://www.apache.org/"
+ },
+ {
+ "title": "Thanks",
+ "url": "http://www.apache.org/foundation/thanks.html"
+ },
+ {
+ "title": "Become a Sponsor",
+ "url": "http://www.apache.org/foundation/sponsorship.html"
+ },
+ {
+ "title": "Security",
+ "url": "http://www.apache.org/security/"
+ }
+ ]
+}
+
+repos: {
+ platforms: [
+ {
+ "name": "Amazon Fire OS",
+ "github": "https://github.com/apache/cordova-amazon-fireos",
+ "apache": "https://git-wip-us.apache.org/repos/asf?p=cordova-amazon-fireos.git;a=summary",
+ "css": "first"
+ },
+ {
+ "name": "Android",
+ "github": "https://github.com/apache/cordova-android",
+ "apache": "https://git-wip-us.apache.org/repos/asf?p=cordova-android.git;a=summary"
+ },
+ {
+ "name": "Bada",
+ "github": "https://github.com/apache/cordova-bada",
+ "apache": "https://git-wip-us.apache.org/repos/asf?p=cordova-bada.git;a=summary"
+ },
+ {
+ "name": "Blackberry",
+ "github": "https://github.com/apache/cordova-blackberry",
+ "apache": "https://git-wip-us.apache.org/repos/asf?p=cordova-blackberry.git;a=summary"
+ },
+ {
+ "name": "FirefoxOS",
+ "github": "https://github.com/apache/cordova-firefoxos",
+ "apache": "https://git-wip-us.apache.org/repos/asf?p=cordova-firefoxos.git;a=summary"
+ },
+ {
+ "name": "iOS",
+ "github": "https://github.com/apache/cordova-ios",
+ "apache": "https://git-wip-us.apache.org/repos/asf?p=cordova-ios.git;a=summary"
+ },
+ {
+ "name": "Mac OS X",
+ "github": "https://github.com/apache/cordova-osx",
+ "apache": "https://git-wip-us.apache.org/repos/asf?p=cordova-osx.git;a=summary"
+ },
+ {
+ "name": "Qt",
+ "github": "https://github.com/apache/cordova-qt",
+ "apache": "https://git-wip-us.apache.org/repos/asf?p=cordova-qt.git;a=summary"
+ },
+ {
+ "name": "Tizen",
+ "github": "https://github.com/apache/cordova-tizen",
+ "apache": "https://git-wip-us.apache.org/repos/asf?p=cordova-tizen.git;a=summary"
+ },
+ {
+ "name": "Ubuntu",
+ "github": "https://github.com/apache/cordova-ubuntu",
+ "apache": "https://git-wip-us.apache.org/repos/asf?p=cordova-ubuntu.git;a=summary"
+ },
+ {
+ "name": "WebOS",
+ "github": "https://github.com/apache/cordova-webos",
+ "apache": "https://git-wip-us.apache.org/repos/asf?p=cordova-webos.git;a=summary"
+ },
+ {
+ "name": "Windows (desktop)",
+ "github": "https://github.com/apache/cordova-windows",
+ "apache": "https://git-wip-us.apache.org/repos/asf?p=cordova-windows.git;a=summary"
+ },
+ {
+ "name": "Windows Phone 7",
+ "github": "https://github.com/apache/cordova-wp7",
+ "apache": "https://git-wip-us.apache.org/repos/asf?p=cordova-wp7.git;a=summary"
+ },
+ {
+ "name": "Windows Phone 8",
+ "github": "https://github.com/apache/cordova-wp8",
+ "apache": "https://git-wip-us.apache.org/repos/asf?p=cordova-wp8.git;a=summary"
+ },
+ {
+ "name": "Browser",
+ "github": "https://github.com/apache/cordova-browser",
+ "apache": "https://git-wip-us.apache.org/repos/asf?p=cordova-browser.git;a=summary"
+ }
+ ],
+ plugins: [
+ {
+ "name": "Battery Status",
+ "github": "https://github.com/apache/cordova-plugin-battery-status",
+ "apache": "https://git-wip-us.apache.org/repos/asf?p=cordova-plugin-battery-status.git;a=summary"
+ },
+ {
+ "name": "Camera",
+ "github": "https://github.com/apache/cordova-plugin-camera",
+ "apache": "https://git-wip-us.apache.org/repos/asf?p=cordova-plugin-camera.git;a=summary"
+ },
+ {
+ "name": "Console",
+ "github": "https://github.com/apache/cordova-plugin-console",
+ "apache": "https://git-wip-us.apache.org/repos/asf?p=cordova-plugin-console.git;a=summary"
+ },
+ {
+ "name": "Contacts",
+ "github": "https://github.com/apache/cordova-plugin-contacts",
+ "apache": "https://git-wip-us.apache.org/repos/asf?p=cordova-plugin-contacts.git;a=summary"
+ },
+ {
+ "name": "Device",
+ "github": "https://github.com/apache/cordova-plugin-device",
+ "apache": "https://git-wip-us.apache.org/repos/asf?p=cordova-plugin-device.git;a=summary"
+ },
+ {
+ "name": "Device Motion",
+ "github": "https://github.com/apache/cordova-plugin-device-motion",
+ "apache": "https://git-wip-us.apache.org/repos/asf?p=cordova-plugin-device-motion.git;a=summary"
+ },
+ {
+ "name": "Device Orientation",
+ "github": "https://github.com/apache/cordova-plugin-device-orientation",
+ "apache": "https://git-wip-us.apache.org/repos/asf?p=cordova-plugin-device-orientation.git;a=summary"
+ },
+ {
+ "name": "Dialogs",
+ "github": "https://github.com/apache/cordova-plugin-dialogs",
+ "apache": "https://git-wip-us.apache.org/repos/asf?p=cordova-plugin-dialogs.git;a=summary"
+ },
+ {
+ "name": "File",
+ "github": "https://github.com/apache/cordova-plugin-file",
+ "apache": "https://git-wip-us.apache.org/repos/asf?p=cordova-plugin-file.git;a=summary"
+ },
+ {
+ "name": "File Transfer",
+ "github": "https://github.com/apache/cordova-plugin-file-transfer",
+ "apache": "https://git-wip-us.apache.org/repos/asf?p=cordova-plugin-file-transfer.git;a=summary"
+ },
+ {
+ "name": "Geolocation",
+ "github": "https://github.com/apache/cordova-plugin-geolocation",
+ "apache": "https://git-wip-us.apache.org/repos/asf?p=cordova-plugin-geolocation.git;a=summary"
+ },
+ {
+ "name": "Globalization",
+ "github": "https://github.com/apache/cordova-plugin-globalization",
+ "apache": "https://git-wip-us.apache.org/repos/asf?p=cordova-plugin-globalization.git;a=summary"
+ },
+ {
+ "name": "In-App Browser",
+ "github": "https://github.com/apache/cordova-plugin-inappbrowser",
+ "apache": "https://git-wip-us.apache.org/repos/asf?p=cordova-plugin-inappbrowser.git;a=summary"
+ },
+ {
+ "name": "Media",
+ "github": "https://github.com/apache/cordova-plugin-media",
+ "apache": "https://git-wip-us.apache.org/repos/asf?p=cordova-plugin-media.git;a=summary"
+ },
+ {
+ "name": "Media Capture",
+ "github": "https://github.com/apache/cordova-plugin-media-capture",
+ "apache": "https://git-wip-us.apache.org/repos/asf?p=cordova-plugin-media-capture.git;a=summary"
+ },
+ {
+ "name": "Network Information",
+ "github": "https://github.com/apache/cordova-plugin-network-information",
+ "apache": "https://git-wip-us.apache.org/repos/asf?p=cordova-plugin-network-information.git;a=summary"
+ },
+ {
+ "name": "Splashscreen",
+ "github": "https://github.com/apache/cordova-plugin-splashscreen",
+ "apache": "https://git-wip-us.apache.org/repos/asf?p=cordova-plugin-splashscreen.git;a=summary"
+ },
+ {
+ "name": "Statusbar",
+ "github": "https://github.com/apache/cordova-plugin-statusbar",
+ "apache": "https://git-wip-us.apache.org/repos/asf?p=cordova-plugin-statusbar.git;a=summary"
+ },
+ {
+ "name": "Vibration",
+ "github": "https://github.com/apache/cordova-plugin-vibration",
+ "apache": "https://git-wip-us.apache.org/repos/asf?p=cordova-plugin-vibration.git;a=summary"
+ }
+ ],
+ other: [
+ {
+ "name": "Cordova Docs",
+ "github": "https://github.com/apache/cordova-docs",
+ "apache": "https://git-wip-us.apache.org/repos/asf?p=cordova-docs.git;a=summary"
+ },
+ {
+ "name": "Cordova JS (JavaScript API)",
+ "github": "https://github.com/apache/cordova-js",
+ "apache": "https://git-wip-us.apache.org/repos/asf?p=cordova-js.git;a=summary"
+ },
+ {
+ "name": "Cordova CLI",
+ "github": "https://github.com/apache/cordova-cli",
+ "apache": "https://git-wip-us.apache.org/repos/asf?p=cordova-cli.git;a=summary"
+ },
+ {
+ "name": "Cordova Plugman (Plugin Manager)",
+ "github": "https://github.com/apache/cordova-plugman",
+ "apache": "https://git-wip-us.apache.org/repos/asf?p=cordova-plugman.git;a=summary"
+ },
+ {
+ "name": "Cordova Lib (Common Code)",
+ "github": "https://github.com/apache/cordova-lib",
+ "apache": "https://git-wip-us.apache.org/repos/asf?p=cordova-lib.git;a=summary"
+ },
+ {
+ "name": "Cordova Mobile Spec (Test Suite)",
+ "github": "https://github.com/apache/cordova-mobile-spec",
+ "apache": "https://git-wip-us.apache.org/repos/asf?p=cordova-mobile-spec.git;a=summary"
+ },
+ {
+ "name": "Cordova Medic (Test Automation)",
+ "github": "https://github.com/apache/cordova-medic",
+ "apache": "https://git-wip-us.apache.org/repos/asf?p=cordova-medic.git;a=summary"
+ },
+ {
+ "name": "Weinre (Web Inspector Remote)",
+ "github": "https://github.com/apache/cordova-weinre",
+ "apache": "https://git-wip-us.apache.org/repos/asf?p=cordova-weinre.git;a=summary"
+ },
+ {
+ "name": "Cordova App Harness",
+ "github": "https://github.com/apache/cordova-app-harness",
+ "apache": "https://git-wip-us.apache.org/repos/asf?p=cordova-app-harness.git;a=summary"
+ },
+ {
+ "name": "Cordova Hello World (Sample App)",
+ "github": "https://github.com/apache/cordova-app-hello-world",
+ "apache": "https://git-wip-us.apache.org/repos/asf?p=cordova-app-hello-world.git;a=summary"
+ },
+ {
+ "name": "Cordova Coho (Release Tool)",
+ "github": "https://github.com/apache/cordova-coho",
+ "apache": "https://git-wip-us.apache.org/repos/asf?p=cordova-coho.git;a=summary"
+ },
+ {
+ "name": "Cordova Registry Web (Plugin Registry UI)",
+ "github": "https://github.com/apache/cordova-registry-web",
+ "apache": "https://git-wip-us.apache.org/repos/asf?p=cordova-registry-web.git;a=summary"
+ },
+ {
+ "name": "Cordova Registry (Plugin Registry App)",
+ "github": "https://github.com/apache/cordova-registry",
+ "apache": "https://git-wip-us.apache.org/repos/asf?p=cordova-registry.git;a=summary"
+ },
+ {
+ "name": "Cordova Labs (Experimental Content)",
+ "github": "https://github.com/apache/cordova-labs",
+ "apache": "https://git-wip-us.apache.org/repos/asf?p=cordova-labs.git;a=summary"
+ }
+ ]
+}
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/fcb4d7c1/www/_includes/analytics.html
----------------------------------------------------------------------
diff --git a/www/_includes/analytics.html b/www/_includes/analytics.html
new file mode 100644
index 0000000..14d66fe
--- /dev/null
+++ b/www/_includes/analytics.html
@@ -0,0 +1,9 @@
+<script>
+ (function(i,s,o,g,r,a,m){i['GoogleAnalyticsObject']=r;i[r]=i[r]||function(){
+ (i[r].q=i[r].q||[]).push(arguments)},i[r].l=1*new Date();a=s.createElement(o),
+ m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.insertBefore(a,m)
+ })(window,document,'script','//www.google-analytics.com/analytics.js','ga');
+
+ ga('create', 'UA-64283057-3', 'auto');
+ ga('send', 'pageview');
+</script>
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/fcb4d7c1/www/_includes/footer.html
----------------------------------------------------------------------
diff --git a/www/_includes/footer.html b/www/_includes/footer.html
new file mode 100644
index 0000000..c2aa257
--- /dev/null
+++ b/www/_includes/footer.html
@@ -0,0 +1,14 @@
+<hr/>
+<div id="footer">
+ <p>Copyright © 2012, 2013 The Apache Software Foundation, Licensed under the <a href="http://www.apache.org/licenses/LICENSE-2.0">Apache License, Version 2.0</a>.<br/>
+ Apache and the Apache feather logos are <a href="http://www.apache.org/foundation/marks/list/">trademarks</a> of The Apache Software Foundation.
+ </p>
+ <a class="closing" href="#top"></a>
+</div>
+
+<!-- JS -->
+<script type="text/javascript" src="{{ "/static/js/lib/smooth.pack.js" | prepend: site.baseurl }}"></script>
+<script type="text/javascript" src="{{ "/static/js/lib/jquery-2.1.1.min.js" | prepend: site.baseurl }}"></script>
+<script type="text/javascript" src="{{ "/static/js/lib/bootstrap.min.js" | prepend: site.baseurl }}"></script>
+<script type="text/javascript" src="{{ "/static/js/lib/toc.min.js" | prepend: site.baseurl }}"></script>
+<script type="text/javascript" src="{{ "/static/js/docs.js" | prepend: site.baseurl }}"></script>
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/fcb4d7c1/www/_includes/head.html
----------------------------------------------------------------------
diff --git a/www/_includes/head.html b/www/_includes/head.html
new file mode 100644
index 0000000..ada9b60
--- /dev/null
+++ b/www/_includes/head.html
@@ -0,0 +1,19 @@
+<head>
+ <meta charset="utf-8">
+ <meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1">
+ <meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />
+ <meta name="format-detection" content="telephone=no">
+ <meta name="viewport" content="user-scalable=no, initial-scale=1, maximum-scale=1, minimum-scale=1, width=device-width" />
+ <meta name="description" content="{% if page.excerpt %}{{ page.excerpt | strip_html | strip_newlines | truncate: 160 }}{% else %}{{ site.description }}{% endif %}">
+
+ <title>{% if page.title %}{{ page.title }}{% else %}{{ site.title }}{% endif %}</title>
+
+ <link rel="SHORTCUT ICON" href="{{ site.baseurl }}/favicon.ico"/>
+ <link rel="canonical" href="{{ page.url | replace:'index.html','' | prepend: site.baseurl | prepend: site.url }}">
+
+ <!-- CSS -->
+ <link rel="stylesheet" type="text/css" href="{{ "/static/css/lib/bootstrap.min.css" | prepend: site.baseurl }}" />
+ <link rel="stylesheet" type="text/css" href="{{ "/static/css/main.css" | prepend: site.baseurl }}">
+ <link rel="stylesheet" type="text/css" href="{{ "/static/css/master.css" | prepend: site.baseurl }}">
+ <link rel="stylesheet" type="text/css" href="{{ "/static/css/docs.css" | prepend: site.baseurl }}">
+</head>
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/fcb4d7c1/www/_includes/header.html
----------------------------------------------------------------------
diff --git a/www/_includes/header.html b/www/_includes/header.html
new file mode 100644
index 0000000..b47675f
--- /dev/null
+++ b/www/_includes/header.html
@@ -0,0 +1,29 @@
+<a class="scroll-point pt-top" name="top">
+</a>
+<div id="header">
+ <div class="wrap">
+ <a class="logo" href="{{ site.baseurl }}/#top"></a>
+ <div class="menu">
+ <a href="{{ site.baseurl }}/#about">About</a>
+ <a href="{{ site.baseurl }}/#news">News</a>
+ <a href="{{ site.data.index-config.sitemap.docs.url }}">Documentation</a>
+ <a href="http://plugins.cordova.io/">Plugins</a>
+ <a href="{{ site.baseurl }}/#links">Quick Links</a>
+ <a href="{{ site.baseurl }}/#contribute">Contribute</a>
+ <a href="{{ site.baseurl }}/#mailing-list">Mailing List</a>
+ </div>
+ <form class="menu-dropdown">
+ <select onchange="location = this.options[this.selectedIndex].value;">
+ <option value="{{ site.baseurl }}/#about">About</option>
+ <option value="{{ site.baseurl }}/#news">News</option>
+ <option value="{{ site.data.index-config.sitemap.docs.url }}">Documentation</option>
+ <option value="http://plugins.cordova.io/">Plugins</option>
+ <option value="{{ site.baseurl }}/#links">Quick Links</option>
+ <option value="{{ site.baseurl }}/#contribute">Contribute</option>
+ <option value="{{ site.baseurl }}/#mailing-list">Mailing List</option>
+ </select>
+ </form>
+ </div>
+ <div class="shadow"></div>
+</div> <!-- /header -->
+<div class="header-placeholder"></div>
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/fcb4d7c1/www/_includes/links.html
----------------------------------------------------------------------
diff --git a/www/_includes/links.html b/www/_includes/links.html
new file mode 100644
index 0000000..ed66160
--- /dev/null
+++ b/www/_includes/links.html
@@ -0,0 +1,53 @@
+<a class="scroll-point" name="links"></a>
+<hr/>
+
+<div class="wrap quick-links-pane">
+ <h2 class="icon icon-quick-links">Quick Links</h2>
+ <br/>
+ <ul class="quick-links-header">
+ <li>General</li>
+ <li>Development</li>
+ <li class="last">Apache Software Foundation</li>
+ </ul>
+ <div class="clear"></div>
+</div>
+
+<div class="grid">
+ <div class="wrap">
+ <div class="list-container">
+ <ul class="list quick-links">
+ <li class="corner"></li>
+ <li><a href="{{ site.baseurl }}{{ site.data.index-config.sitemap.about.url }}">{{ site.data.index-config.sitemap.about.title }}<span></span></a></li>
+
+ {% for links in site.data.index-config.sitemap.general %}
+ <li><a href="{{ links.url }}">{{ links.title }}<span></span></a></li>
+ {% endfor %}
+
+ <li><a href="{{ site.baseurl }}{{ site.data.index-config.sitemap.artwork.url }}">{{ site.data.index-config.sitemap.artwork.title }}<span></span></a></li>
+ </ul>
+
+ <ul class="list quick-links">
+ <li class="corner"></li>
+ <li><a href="{{ site.baseurl }}{{ site.data.index-config.sitemap.download.url }}">{{ site.data.index-config.sitemap.download.title }}<span></span></a></li>
+ <li><a href="{{ site.data.index-config.sitemap.docs.url }}">{{ site.data.index-config.sitemap.docs.title }}<span></span></a></li>
+
+ {% for links in site.data.index-config.sitemap.dev %}
+ <li><a href="{{ links.url }}">{{ links.title }}<span></span></a></li>
+ {% endfor %}
+
+ <li><a href="{{ site.baseurl }}{{ site.data.index-config.sitemap.mailing-list.url }}">{{ site.data.index-config.sitemap.mailing-list.title }}<span></span></a></li>
+
+ <li><a href="http://stackoverflow.com/tags/cordova">Support<span></span></a></li>
+ </ul>
+
+ <ul class="list quick-links last">
+ <li class="corner"></li>
+ {% for links in site.data.index-config.sitemap.asf %}
+ <li><a href="{{ links.url }}">{{ links.title }}<span></span></a></li>
+ {% endfor %}
+ </ul>
+
+ <div class="clear"></div>
+ </div>
+ </div>
+</div>
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/fcb4d7c1/www/_layouts/cordova.html
----------------------------------------------------------------------
diff --git a/www/_layouts/cordova.html b/www/_layouts/cordova.html
new file mode 100644
index 0000000..a5c4fb5
--- /dev/null
+++ b/www/_layouts/cordova.html
@@ -0,0 +1,11 @@
+<!DOCTYPE html>
+<html lang="{{ page.language }}">
+{% include head.html %}
+<body>
+ {% include header.html %}
+ {{ content }}
+ {% include links.html %}
+ {% include footer.html %}
+ {% include analytics.html %}
+</body>
+</html>
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/fcb4d7c1/www/_layouts/docs-de.html
----------------------------------------------------------------------
diff --git a/www/_layouts/docs-de.html b/www/_layouts/docs-de.html
new file mode 100644
index 0000000..91d28ab
--- /dev/null
+++ b/www/_layouts/docs-de.html
@@ -0,0 +1,6 @@
+---
+layout: docs
+toc_text: Inhaltsverzeichnis
+---
+
+{{ content }}
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/fcb4d7c1/www/_layouts/docs-en.html
----------------------------------------------------------------------
diff --git a/www/_layouts/docs-en.html b/www/_layouts/docs-en.html
new file mode 100644
index 0000000..3387436
--- /dev/null
+++ b/www/_layouts/docs-en.html
@@ -0,0 +1,7 @@
+---
+layout: docs
+not_latest_warning_text: This is not the latest version of the documentation!
+toc_text: Table of Contents
+---
+
+{{ content }}
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/fcb4d7c1/www/_layouts/docs-es.html
----------------------------------------------------------------------
diff --git a/www/_layouts/docs-es.html b/www/_layouts/docs-es.html
new file mode 100644
index 0000000..7494096
--- /dev/null
+++ b/www/_layouts/docs-es.html
@@ -0,0 +1,7 @@
+---
+layout: docs
+title: Documentación Apache Cordova
+toc_text: Tabla de Contenidos
+---
+
+{{ content }}
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/fcb4d7c1/www/_layouts/docs-fr.html
----------------------------------------------------------------------
diff --git a/www/_layouts/docs-fr.html b/www/_layouts/docs-fr.html
new file mode 100644
index 0000000..ae4691a
--- /dev/null
+++ b/www/_layouts/docs-fr.html
@@ -0,0 +1,8 @@
+---
+layout: docs
+title: Documentation API Apache Cordova
+not_latest_warning_text: Ca n'est past la dernière version de la documentation.
+toc_text: Table des Matières
+---
+
+{{ content }}
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/fcb4d7c1/www/_layouts/docs-it.html
----------------------------------------------------------------------
diff --git a/www/_layouts/docs-it.html b/www/_layouts/docs-it.html
new file mode 100644
index 0000000..a259ed8
--- /dev/null
+++ b/www/_layouts/docs-it.html
@@ -0,0 +1,6 @@
+---
+layout: docs
+toc_text: Sommario
+---
+
+{{ content }}
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/fcb4d7c1/www/_layouts/docs-ja.html
----------------------------------------------------------------------
diff --git a/www/_layouts/docs-ja.html b/www/_layouts/docs-ja.html
new file mode 100644
index 0000000..d72cc7c
--- /dev/null
+++ b/www/_layouts/docs-ja.html
@@ -0,0 +1,6 @@
+---
+layout: docs
+toc_text: 目次
+---
+
+{{ content }}
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/fcb4d7c1/www/_layouts/docs-ko.html
----------------------------------------------------------------------
diff --git a/www/_layouts/docs-ko.html b/www/_layouts/docs-ko.html
new file mode 100644
index 0000000..314e57d
--- /dev/null
+++ b/www/_layouts/docs-ko.html
@@ -0,0 +1,6 @@
+---
+layout: docs
+toc_text: 차례
+---
+
+{{ content }}
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/fcb4d7c1/www/_layouts/docs-pl.html
----------------------------------------------------------------------
diff --git a/www/_layouts/docs-pl.html b/www/_layouts/docs-pl.html
new file mode 100644
index 0000000..3610acb
--- /dev/null
+++ b/www/_layouts/docs-pl.html
@@ -0,0 +1,6 @@
+---
+layout: docs
+toc_text: Spis treści
+---
+
+{{ content }}
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/fcb4d7c1/www/_layouts/docs-ru.html
----------------------------------------------------------------------
diff --git a/www/_layouts/docs-ru.html b/www/_layouts/docs-ru.html
new file mode 100644
index 0000000..7e26906
--- /dev/null
+++ b/www/_layouts/docs-ru.html
@@ -0,0 +1,14 @@
+---
+layout: docs
+title: Документация API Apache Cordova
+not_latest_warning_text: Это не самая последняя версия документации!
+toc_text: Содержание
+---
+
+<style type="text/css">
+ #home ul li {
+ height: 160px;
+ }
+</style>
+
+{{ content }}
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/fcb4d7c1/www/_layouts/docs-sl.html
----------------------------------------------------------------------
diff --git a/www/_layouts/docs-sl.html b/www/_layouts/docs-sl.html
new file mode 100644
index 0000000..6e28eb8
--- /dev/null
+++ b/www/_layouts/docs-sl.html
@@ -0,0 +1,6 @@
+---
+layout: docs
+toc_text: Kazalo
+---
+
+{{ content }}
---------------------------------------------------------------------
To unsubscribe, e-mail: commits-unsubscribe@cordova.apache.org
For additional commands, e-mail: commits-help@cordova.apache.org