Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Fix links to php file extensions and update front page
- Loading branch information
1 parent
45107e4
commit 7106216
Showing
7 changed files
with
274 additions
and
1,408 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,75 +1,104 @@ | ||
AMEEconnect Documentation (v3) | ||
============================== | ||
|
||
This is the documentation for AMEEconnect, API version 3, written in Markdown. | ||
For version 2 documentation, please check out the v2_maintenance branch. | ||
Welcome to the AMEE Connect API documentation. | ||
|
||
This work is licensed under a [Creative Commons Attribution-ShareAlike 3.0 Unported License](http://creativecommons.org/licenses/by-sa/3.0/). | ||
API version 3.6 | ||
--------------- | ||
|
||
* * * * * | ||
|
||
**Table of Contents** | ||
|
||
[Introduction](sections/introduction.md) | ||
|
||
[About This Manual](sections/introduction.md#about) | ||
|
||
[Before You Start](sections/introduction.md#before-you-start) | ||
|
||
[API Versions](sections/introduction.md#api-versions) | ||
|
||
[Quick Start](sections/quickstart.md) | ||
|
||
[Getting Started](sections/quickstart.md#getting-started) | ||
|
||
[Choose Your Model](sections/quickstart.md#quick-choose-data-item) | ||
|
||
[Do the Calculation](sections/quickstart.md#quick-do-calculation) | ||
|
||
[Get Emission Factors](sections/data.md) | ||
|
||
[Models and Contexts](sections/data.md#models) | ||
|
||
[Using AMEEdiscover](sections/data.md#ameediscover) | ||
|
||
Requirements | ||
------------ | ||
[Fetching Emission Factors](sections/data.md#get-data-items) | ||
|
||
On OSX: | ||
[Perform Calculations](sections/calculations.md) | ||
|
||
* XCode or the XCode command line tools | ||
* Homebrew | ||
* RVM with Ruby 1.9.2 | ||
[Doing a Calculation](sections/calculations.md#doing-calculations) | ||
|
||
Then: | ||
[Getting Results](sections/calculations.md#getting-results) | ||
|
||
> brew install docbook fop | ||
> bundle | ||
[Store Data](sections/profiles.md) | ||
|
||
Manual Builds | ||
------------- | ||
[Using AMEEconnect to Store Data](sections/profiles.md#store-data) | ||
|
||
> make [TARGET] | ||
[Creating a Profile](sections/profiles.md#create-profile) | ||
|
||
standard targets: | ||
[Storing Inputs](sections/profiles.md#create-profile-item) | ||
|
||
* `html-chunk`: HTML multi page, generally used in development | ||
* `php-chunk`: PHP multi page for use in AMEE's wordpress site (this is the default) | ||
[Fetching Return Values](sections/profiles.md#retrieve-items) | ||
|
||
other targets (used less often, and may not currently work properly): | ||
[List Stored Profile Items](sections/profiles.md#list-items) | ||
|
||
* `pdf`: single PDF | ||
* `html`: single page HTML | ||
[Building Time Series](sections/profiles.md#build-time-series) | ||
|
||
Deploying to the live site | ||
-------------------------- | ||
[Naming Profile Items](sections/profiles.md#naming-items) | ||
|
||
> make | ||
> cap {staging|production} deploy | ||
[Time Series Queries](sections/profiles.md#time-series-queries) | ||
|
||
Regenerating Samples | ||
-------------------- | ||
[Advanced Options](sections/advanced.md) | ||
|
||
First time only: | ||
[Specifying API Version](sections/advanced.md#specifying-api-versions) | ||
|
||
> cp src/doc/samples/amee.example.yml src/doc/samples/amee.yml | ||
> vi src/doc/samples/amee.yml | ||
[Units](sections/advanced.md#units) | ||
|
||
Every time: | ||
[Matrix Parameters](sections/advanced.md#matrix-parameters) | ||
|
||
> make samples | ||
[Search](sections/advanced.md#search) | ||
|
||
To add new samples, edit src/doc/samples/Rakefile and add a new request. Then include the generated | ||
file from the samples directory, which will include the XML and JSON variants automatically. | ||
[Authority](sections/advanced.md#authority) | ||
|
||
Automated Builds | ||
---------------- | ||
[Paging](sections/advanced.md#paging) | ||
|
||
From the root directory, run: | ||
[Interactive Context Selection](sections/advanced.md#interactive-drilldowns) | ||
|
||
> guard | ||
[AMEEconnect API reference](sections/reference.md) | ||
|
||
This should set up automatic building of the html-chunk documentation. A config.ru file is | ||
included so you can view it with pow.cx if you want to (may be useful for livereload, though | ||
I've not set that up yet). | ||
[Models](sections/reference.md#data-category-reference) | ||
|
||
Editing | ||
------- | ||
[Contexts](sections/reference.md#data-item-reference) | ||
|
||
Edit the individual files in src/doc to change text. src/doc/translations.ent contains shared | ||
HTML entites for common terms, to make changing them across the entire document simple. To change | ||
layout or container content for any of the builds, see the XSL stylesheets in src/stylesheets. | ||
[Emission Factors](sections/reference.md#data-item-value-reference) | ||
|
||
[Profiles](sections/reference.md#profile-reference) | ||
|
||
[Profile Items](sections/reference.md#profile-item-reference) | ||
|
||
[Batch Operations](sections/reference.md#batch-operations-reference) | ||
|
||
[Search](sections/reference.md#search-reference) | ||
|
||
[Authentication](sections/reference.md#auth-reference) | ||
|
||
[UIDs](sections/reference.md#uid-reference) | ||
|
||
[Date and Time Representation](sections/reference.md#date-reference) | ||
|
||
[References](sections/bib.md) | ||
|
||
|
||
|
||
|
||
This work is licensed under a [Creative Commons Attribution-ShareAlike 3.0 Unported License](http://creativecommons.org/licenses/by-sa/3.0/). |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.