Update dashboard imgs

.readthedocs.yaml

@@ -0,0 +1,35 @@
+# Read the Docs configuration file for Sphinx projects
+# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details
+
+# Required
+version: 2
+
+# Set the OS, Python version and other tools you might need
+build:
+  os: ubuntu-22.04
+  tools:
+    python: "3.12"
+    # You can also specify other tool versions:
+    # nodejs: "20"
+    # rust: "1.70"
+    # golang: "1.20"
+
+# Build documentation in the "docs/" directory with Sphinx
+sphinx:
+  configuration: "source/conf.py"  
+  # You can configure Sphinx to use a different builder, for instance use the dirhtml builder for simpler URLs
+  # builder: "html"
+  # Fail on all warnings to avoid broken references
+  # fail_on_warning: true
+
+# Optionally build your docs in additional formats such as PDF and ePub
+# formats:
+#   - pdf
+#   - epub
+
+# Optional but recommended, declare the Python requirements required
+# to build your documentation
+# See https://docs.readthedocs.io/en/stable/guides/reproducible-builds.html
+python:
+  install:
+    - requirements: requirements.txt

.yaml

@@ -0,0 +1,35 @@
+# Read the Docs configuration file for Sphinx projects
+# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details
+
+# Required
+version: 2
+
+# Set the OS, Python version and other tools you might need
+build:
+  os: ubuntu-22.04
+  tools:
+    python: "3.12"
+    # You can also specify other tool versions:
+    # nodejs: "20"
+    # rust: "1.70"
+    # golang: "1.20"
+
+# Build documentation in the "docs/" directory with Sphinx
+sphinx:
+  configuration: source/conf.py 
+  # You can configure Sphinx to use a different builder, for instance use the dirhtml builder for simpler URLs
+  # builder: "dirhtml"
+  # Fail on all warnings to avoid broken references
+  # fail_on_warning: true
+
+# Optionally build your docs in additional formats such as PDF and ePub
+# formats:
+#   - pdf
+#   - epub
+
+# Optional but recommended, declare the Python requirements required
+# to build your documentation
+# See https://docs.readthedocs.io/en/stable/guides/reproducible-builds.html
+# python:
+#   install:
+#     - requirements: docs/requirements.txt

build/html/_sources/technical.txt

@@ -15,7 +15,7 @@ delete privileges only (no create table privileges).  This “coral” user shou
 The CORAL modules are heavily data-driven.  As a result we have provided an initial “snapshot” of our 
 data which will be inserted when the MySQL tables are created.  Most of this data may be edited 
 through the front-end if desired – refer to the user guide for more information. 
-For data models and the MySQL Workbench file, refer to http://coral-erm.org/documentation  
+For data models and the MySQL Workbench file, refer to https://coral-erm.org/documentation  
 
 #### Server-side scripting 
 
@@ -134,7 +134,7 @@ suffix
 Installation can occur in one of two ways – either through the web installation script or manually.  Web 
 installation will provide advantages over manual installation because it will check MySQL privileges and PHP version.
 
-When you first [download the scripts](http://coral-erm.org/download), it is recommended to place each one into a parent `/coral/` directory if your server is sharing space with other applications.  This is optional but it helps group all of the coral applications together. 
+When you first [download the scripts](https://coral-erm.org/download), it is recommended to place each one into a parent `/coral/` directory if your server is sharing space with other applications.  This is optional but it helps group all of the coral applications together. 
 
 For example you may have:  
 ```
@@ -315,7 +315,7 @@ where they appear but leave the format alone.
 
 ### Upgrades 
 Upgrades to CORAL will be announced through the CORAL ERM Listserv.  If you wish to be added, please 
-consult http://coral-erm.org or email [email protected] directly. 
+consult https://coral-erm.org or email [email protected] directly. 
 
 In general, small upgrades with simple coding changes will not be given their own version numbers.  If
 an institution notifies us about a bug we will let them know directly when the bug fix is available.  

build/html/index.html

@@ -6,7 +6,7 @@
   <head>
     <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
 
-    <title>CORAL Documentation Project &#8212; coral_documentation_project 0.0.1 documentation</title>
+    <title>CORAL Documentation Project &#8212; Coral Documentation Project 0.0.1 documentation</title>
 
     <link rel="stylesheet" href="_static/alabaster.css" type="text/css" />
     <link rel="stylesheet" href="_static/pygments.css" type="text/css" />
@@ -25,7 +25,7 @@
     <script type="text/javascript" src="_static/doctools.js"></script>
     <link rel="index" title="Index" href="genindex.html" />
     <link rel="search" title="Search" href="search.html" />
-    <link rel="top" title="coral_documentation_project 0.0.1 documentation" href="#" />
+    <link rel="top" title="Coral Documentation Project 0.0.1 documentation" href="#" />
     <link rel="next" title="Overview: the CORAL Project" href="overview.html" />
 
   <link rel="stylesheet" href="_static/custom.css" type="text/css" />
@@ -353,4 +353,4 @@ <h3>Quick search</h3>
 
 
   </body>
-</html>
+</html>

build/html/technical.html

@@ -61,7 +61,7 @@
 <p>The CORAL modules are heavily data-driven.  As a result we have provided an initial “snapshot” of our
 data which will be inserted when the MySQL tables are created.  Most of this data may be edited
 through the front-end if desired – refer to the user guide for more information.
-For data models and the MySQL Workbench file, refer to http://coral-erm.org/documentation</p>
+For data models and the MySQL Workbench file, refer to https://coral-erm.org/documentation</p>
 </div>
 <div class="section" id="server-side-scripting">
 <span id="server-side-scripting"></span><h3>Server-side scripting<a class="headerlink" href="#server-side-scripting" title="Permalink to this headline">¶</a></h3>
@@ -184,7 +184,7 @@
 <span id="installation"></span><h2>Installation<a class="headerlink" href="#installation" title="Permalink to this headline">¶</a></h2>
 <p>Installation can occur in one of two ways – either through the web installation script or manually.  Web
 installation will provide advantages over manual installation because it will check MySQL privileges and PHP version.</p>
-<p>When you first <a class="reference external" href="http://coral-erm.org/download">download the scripts</a>, it is recommended to place each one into a parent <code class="docutils literal"><span class="pre">/coral/</span></code> directory if your server is sharing space with other applications.  This is optional but it helps group all of the coral applications together.</p>
+<p>When you first <a class="reference external" href="https://coral-erm.org/download">download the scripts</a>, it is recommended to place each one into a parent <code class="docutils literal"><span class="pre">/coral/</span></code> directory if your server is sharing space with other applications.  This is optional but it helps group all of the coral applications together.</p>
 <p>For example you may have:</p>
 <div class="highlight-default"><div class="highlight"><pre><span></span><span class="o">/</span><span class="n">coral</span><span class="o">/</span><span class="n">resources</span><span class="o">/</span>
 <span class="o">/</span><span class="n">coral</span><span class="o">/</span><span class="n">licensing</span><span class="o">/</span>
@@ -345,7 +345,7 @@
 <div class="section" id="upgrades">
 <span id="upgrades"></span><h2>Upgrades<a class="headerlink" href="#upgrades" title="Permalink to this headline">¶</a></h2>
 <p>Upgrades to CORAL will be announced through the CORAL ERM Listserv.  If you wish to be added, please
-consult http://coral-erm.org or email coral-admin&#64;listserv.nd.edu directly.</p>
+consult https://coral-erm.org or email coral-admin&#64;listserv.nd.edu directly.</p>
 <p>In general, small upgrades with simple coding changes will not be given their own version numbers.  If
 an institution notifies us about a bug we will let them know directly when the bug fix is available.Versioning will happen when there is a database structure change or configuration file change.</p>
 <p>When performing upgrades your configuration file (<code class="docutils literal"><span class="pre">/admin/configuration.ini</span></code>) should always be backed

desktop.ini

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

requirements.txt

@@ -0,0 +1,3 @@
+sphinx>=4.0.0 
+recommonmark>=0.7.1 
+docutils<0.18

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/conf.py

@@ -357,3 +357,18 @@
 # If true, do not generate a @detailmenu in the "Top" node's menu.
 #
 # texinfo_no_detailmenu = False
+
+# -- Additional Settings recommended by ReadtheDocs in July 16th Email ------------------------
+import os
+
+# Set canonical URL from the Read the Docs Domain
+html_baseurl = os.environ.get("READTHEDOCS_CANONICAL_URL", "")
+
+# Initialize html_context?
+html_context = {} 
+
+# Tell Jinja2 templates the build is running on Read the Docs 
+if os.environ.get("READTHEDOCS", "") == "True": 
+    html_context["READTHEDOCS"] = True
+
+

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)
+
+
+
+
+
+
+
+
+
+