Rebecca

desktop.ini

@@ -0,0 +1,4 @@
+[ViewState]
+Mode=
+Vid=
+FolderType=Generic

source/api.md

@@ -0,0 +1,46 @@
+## Propose New Resource API
+
+This API allows users to submit a new resource order request to CORAL Resource module via a client form. 
+
+### The API and the Client Form 
+The API is based on [Flight](http://flightphp.com/), a simple and extensible framework for PHP.   
+
+![Screenshot of API Client Form](img/api/apiClientForm.png)
+
+This is a sample of a client form, which is based on [unirest]( http://unirest.io/php.html ). Users can enter resource information in the form. This includes basic information about the resource including Title, Description, Provider, ISBN/ISSN, URL and information about the order such as fund code and cost. For Format, Acquisition Type, Resource Type, and Fund code, the data showing on the form are populated from the data predefined in Coral Admin tab. Data entered here are mapped to fields in CORAL Resources. Other fields without a matching CORAL field are loaded into CORAL as general notes. If a specific note type is created in CORAL, they can be mapped to the desired note type.  
+
+Once submitted, a report is presented with a summary of the fields. A new resource record is created automatically in CORAL Resource module. If data entered in Format, Acquisition Type and Resource Type match with what determine a workflow, the workflow is triggered once the record is submitted via the client form. 
+
+### API Configuration
+
+#### Server-side:
+
+Edit resources/admin/configuration.ini and fill apiAuthorizedIP with the IP address of the client accessing the API:
+apiAuthorizedIP="192.168.1.1"
+
+You can set multiple IPs (comma-separated):
+apiAuthorizedIP="192.168.1.1,192.168.2"
+
+You can also set incomplete IPs so the whole range will be allowed:
+apiAuthorizedIP="192.168.1"
+(will authorize all IPs from 192.168.1.1 to 192.168.1.255)
+
+If you are trying to test the example form and it is on the same machine as Coral, 127.0.0.1 should work.
+
+Hint: if you don't know which IP address will be requesting the API, just leave apiAuthorizedIP blank (apiAuthorizedIP="") and access the example form with your browser (http://yourcoral.tld/resources/api_client/ ), you will get an error like this:
+You are not authorized to use this service.
+Unauthorized IP: 127.0.0.1
+
+#### Client-side:
+
+Edit api_client/index.php and set the $server variable:
+$server = "http://yourcoral.tld/resources/api/"; 
+
+### Install Composer, Flight and Unirest
+In addition, you'll need to install Composer, Flight and Unirest. Install Composer, then run the "php computer.phar install" command from inside the [CORAL BASE DIR]/resources/api/directory. This will bring in and manage the Flight dependency for you. 
+
+Then navigate to [CORAL BASE DIR]/resources/api_client/  and run the ‘php composer.phar install’ command again. This will bring in and manage the Unirest dependency for you. Check out  [https://packagist.org/](https://packagist.org/) for instruction on getting Composer installed. The exact composer install command might be slightly different depending on which Composer install option you choose.
+
+Note that the Acquisition Type is hardcoded to show two options Approved and Need Approval. This can be customized to show desired acquisition types by modifying index.php (in the api_client folder). Users can either edit line 330 or remove line 330 and line 334. See the code in the screenshot below. 
+
+![Screenshot of API Client IndexPHP File](img/api/apiClientIndexphp.png)

source/dashboards.md

@@ -0,0 +1,36 @@
+Dashboards User Guide
+---------------------------------
+
+### About CORAL Resources Dashboards
+
+![Screenshot of Dashboards Home Menu](img/dashboards/dashboardsHomeMenu.PNG)
+
+The CORAL dashboards provide a quick overview of resource and cost info.
+
+Note: Enhanced Cost history must be enabled to use Dashboards in CORAL. See [Additional Server Configuration](http://docs.coral-erm.org/en/latest/manual.html#additional-server-configuration)
+
+### Statistics Dashboard
+
+![Screenshot of Dashboards Statistics](img/dashboards/dashboardsStatistics.PNG)
+
+Dashboards Statistics allows for a quick display of your Resources data by Resource Type, Subject, Acquisition Type, Order Type, Cost Details, and Year.  You can also Group By: Resource, Resource Type, Subject, and Acquisition Type.  Once your criteria has been selected click Display to view your results or Export to export your results.  
+
+![Screenshot of Dashboards Statistics Results](img/dashboards/dashboardsStatisticsResults.PNG)
+
+### Yearly Costs Dashboard
+
+![Screenshot of Dashboards Yearly Cost](img/dashboards/dashboardsYearlyCost.PNG)
+
+Yearly Costs allows for a quick display of your Resources data by Resource Type, Subject, Acquisition Type, Order Type, Cost Details, and Year Start and end dates.  You can also Group By: Resource, Resource Type,  Subject, and Acquisition Type, Organization and Fund.  You can also view total sum for all cost details. Once your criteria has been selected click Display to view your results or Export to export your results. 
+
+![Screenshot of Dashboards Yearly Cost](img/dashboards/dashboardsYearlyCostResults.PNG)
+
+
+
+
+
+
+
+
+
+

source/docstyleguide.md

@@ -1,17 +1,27 @@
-CORAL Documentation Style Guide
+git CORAL Documentation Style Guide
 -------------------------------
 
 ### About the Style Guide ###
 
 The purpose of the style guide is to help keep the documentation consistent in style while at the same time providing tips for contributing to the CORAL Documentation Project (CDP) and other relevant information.
 
+### Helping Out
+
+The CDP is a great way to participate in a small or big way as time allows.  Take something in the documentation that you would like to improve and help out, whether it is editing, adding new content, or just sharing a tip.  All the information needed to get started is found below.  When finished you will need to submit a pull request in GitHub for any changes.  The Web Committee will review these pull requests and merge them into the documentation as they are approved.  For any suggestions or questions about helping out, please email us at [help@coral-erm.org](mailto:help@coral-erm.org).  
+
 ### Setting Up ###
 
 The CDP is managed in a repo on GitHub found at [https://github.com/Coral-erm 
-](https://github.com/Coral-erm  "https://github.com/Coral-erm ").  The project uses the [Sphinx Python Documentation Generator](http://www.sphinx-doc.org/en/stable/) and [ReCommonMark](http://recommonmark.readthedocs.io/en/latest/).  The documentation files are edited in a combination of [reStructuredText](https://en.wikipedia.org/wiki/ReStructuredText) and [Markdown](https://en.wikipedia.org/wiki/Markdown), both markup languages supported by GitHub.  In addition, [Read the Docs](https://readthedocs.org/) is used for hosting the documentation and providing additional documentation conversion and indexing tools.   
+](https://github.com/Coral-erm  "https://github.com/Coral-erm ").  The project uses the [Sphinx Python Documentation Generator](http://www.sphinx-doc.org/en/stable/) and [ReCommonMark](http://recommonmark.readthedocs.io/en/latest/).  The documentation files are edited in a combination of [reStructuredText](https://en.wikipedia.org/wiki/ReStructuredText) and [Markdown](https://en.wikipedia.org/wiki/Markdown), both markup languages supported by GitHub.  In addition, [Read the Docs](https://readthedocs.org/) is used for hosting the documentation and providing additional documentation conversion and indexing tools.  
+
+### Editing Markdown
+
+There are a lot of great resources online about Markdown, but to get started you may want to use a Markdown editor.  There are many available free, but the best one for you will depend on your operating system.  One suggestion for Microsoft Windows would be [MarkdownPad](http://markdownpad.com/).      
 
 ### Basic Instructions on Getting Started with GitHub
 
+Note: For first times users you will need to have a GitHub account.  To create an account, go to [https://github.com](https://github.com).  You will also need to install some type of GitHub client software on your PC.  For the instructions below, we are using Git for Windows.  You can download Git for Windows at [https://git-scm.com](https://git-scm.com).  
+
 **Git and Github Documentation Workflow Procedures**
 
 *Note: Except as noted the following instructions are for Microsoft Windows using the command line prompt. *
@@ -36,9 +46,9 @@ Running this command will do a few things including identifying what github acco
 
 7. You should now be in the master branch of the repo.  You can use **`git status`** to see what branch is currently selected.  You could make changes to the master branch, but when you copy these changes back to github you would be directly merging your changes into the master branch of the repo.  Instead what you want to do is create a branch of the master version, so that later on when you copy your changes back to github, you have to go through another step, in github lingo a "push request," to request that your changes be merged into the master branch.  This allows for you to make sure you don’t inadvertently write over another person’s changes in the master branch.  Use the following command to create a new branch from the master.  Command: **`git checkout –b <branchname>`**   (If the branch name already exists use **`git checkout <branchname>`**).  You can now start making changes to your files.  Feel  free to do this by commandline or gui.  For us we are going to use Windows Explorer to navigate to the following folder.  Taking our example earlier.  **`C:\Work\Documentation\Source`**
 
-You will notice that there are two folders under Documentation.  Build and Source.  You will be working primarily with the Source.  This is where the individual files for the documentation are to found.  There are two files types of importance:  .md = Markdown files and .rst = Restructured Files.  Restructured Files are Python files used by the Sphinx Documentation Generator.  We are using only one of these files at this time.  This file is being used primarily to create our Table of Contents structure.  For now, you will be editing primarily the Markdown files.  Use the recommended MarkPad 2 for Windows application to open the files.
+You will notice that there are two folders under Documentation.  Build and Source.  Most users will be working exclusively with the Source.  This is where the individual files for the documentation are to found.  There are two files types of importance:  .md = Markdown files and .rst = Restructured Files.  Restructured Files are Python files used by the Sphinx Documentation Generator.  We are using only one of these files at this time.  This file is being used primarily to create our Table of Contents structure.  For now, you will be editing primarily the Markdown files.  If using Microsoft Windows, you can use the recommended MarkPad 2 for Windows application to open the files.
 
-8. Make whatever edits you need to the Markdown files and be sure to save your changes.  Be sure to save your changes.  Once finished you are now ready to build your HTML files from your Markdown files.
+8. Make whatever edits you need to the Markdown files and be sure to save your changes. 
 
 9. Go back to your command line and change your working directory to the following.  For our example,  **`C:\Work\Documentation`**
 
@@ -60,11 +70,33 @@ The command **`git push` **will work alone when you have an established connecti
 
 17. You should receive the message "This branch has no conflicts with the base branch."  If so, and you have permission to do so, go ahead and select the green “Merge pull request” button to merge your changes into the master.  Other options here include adding a comment or closing the pull request.  
 
-Note:  If you are more comfortable having someone else merge the code, feel free to request this via the comment field.  Likewise, admin rights are required to merge the pull request.  Only members on the Web Committee and Steering Committee will be granted these rights, so in this case outside parties submitting a pull request will require someone on our committee to review, approve, and merge.  
+Note:  Admin rights are required to merge the pull request.  Only members on the Web Committee and Steering Committee have these rights, so in this case outside parties submitting a pull request will require someone on our committee to review, approve, and merge the changes.  
 
 18. After clicking on the "Merge pull request" button click the “Confirm merge” button.  You should receive the message “Pull request successfully merged and closed.”  Go ahead and delete your branch by pushing the “Delete branch” button.  Doing this will keep your workflow cleaner.  Likewise, creating a new branch when needed will keep your working files closer to the master branch.   Once you have committed your changes they will be updated in generally less than a minute at [http://docs.coral-erm.org/](http://docs.coral-erm.org/).  If changes don’t appear right away, try refreshing the cache in your browser.
 
-19. You have finished the process of cloning the repo, creating a branch, making updates to the source files, committing the changes in your new branch to the repo, and finally merging those changes into the master branch.  
+19. You have finished the process of cloning the repo, creating a branch, making updates to the source files, committing the changes in your new branch to the repo, and finally merging those changes into the master branch.
+
+### Updating Documentation Versions 
+
+Follow instructions from "Basic Instructions on Getting Started with Github" with the following differences.
+
+To preserve a version of the documentation a branch repo has been created for that version.  You will want to clone that branch repo instead of the master repo.
+
+For example use the following git command to clone the branch:
+
+**`git clone -b v2.0.1-Documentation -single-branch https://github.com/coral-erm/Documentation.git`**
+
+Change the branch name, make your edits and use the git add, commit, and push commands as described under the "Basic Instructions..." 
+
+Use the following git push format:
+
+**`git push https://github.com/coral-erm/Documentation <your branchname>`**
+
+Once your new branch has been committed and pushed to Github be sure to setup the pull request to merge your branch into the version branch originally cloned.  
+
+### Updating the Table of Contents Structure (TOC)
+
+
 
 
 ### File Structure and File Naming Conventions ###