Update side navbar by datasheet scope

ApexRMS · Nov 1, 2023 · 62c714d · 62c714d
1 parent 8b24cb5
commit 62c714d
Show file tree

Hide file tree

Showing 11 changed files with 289 additions and 112 deletions.
diff --git a/docs/_config.yml b/docs/_config.yml
@@ -7,5 +7,10 @@ header_pages:
   - getting_started.md
   - reference.md
 collections:
-  sections:
-    output: true
+  scenarios:
+    output: true
+  library:
+    output: true
+  project:
+    output: true
+
diff --git a/docs/_sections/section0.md → docs/_library/library0.md b/docs/_sections/section0.md → docs/_library/library0.md
@@ -7,9 +7,28 @@ permalink: reference/network
 
 <!--- Sidebar Navigation Menu --->
 <div class="sidenav">
-    {% for section in site.sections %}
-        <a href="{{site.baseurl}}{{ section.url }}"> <b>{{ section.title }}</b> </a>
-        {% if section.section == page.section %}
+    <li>Library</li>
+    {% for section in site.library %}
+        {% if section.section != page.section %}
+            <a href="{{site.baseurl}}{{ section.url }}"> &emsp;{{ section.title }} </a>
+        {% else %}
+            <a class="selected" href="{{site.baseurl}}{{ section.url }}"> &emsp;{{ section.title }} </a>
+        {% endif %}
+    {% endfor %}
+    <li>Project</li>
+    {% for section in site.project %}
+        {% if section.section != page.section %}
+            <a href="{{site.baseurl}}{{ section.url }}"> &emsp;{{ section.title }} </a>
+        {% else %}
+            <a class="selected" href="{{site.baseurl}}{{ section.url }}"> &emsp;{{ section.title }} </a>
+        {% endif %}
+    {% endfor %}
+    <li>Scenario</li>
+    {% for section in site.scenarios %}
+        {% if section.section != page.section %}
+            <a href="{{site.baseurl}}{{ section.url }}"> &emsp;{{ section.title }} </a>
+        {% else %}
+            <a class="selected" href="{{site.baseurl}}{{ section.url }}"> &emsp;{{ section.title }} </a>
         {% endif %}
     {% endfor %}
 </div>

diff --git a/docs/_project/project1.md b/docs/_project/project1.md
@@ -0,0 +1,63 @@
+---
+layout: default
+section: 1
+title: Covariates
+permalink: reference/covariates
+---
+
+<!--- Sidebar Navigation Menu --->
+<div class="sidenav">
+    <li>Library</li>
+    {% for section in site.library %}
+        {% if section.section != page.section %}
+            <a href="{{site.baseurl}}{{ section.url }}"> &emsp;{{ section.title }} </a>
+        {% else %}
+            <a class="selected" href="{{site.baseurl}}{{ section.url }}"> &emsp;{{ section.title }} </a>
+        {% endif %}
+    {% endfor %}
+    <li>Project</li>
+    {% for section in site.project %}
+        {% if section.section != page.section %}
+            <a href="{{site.baseurl}}{{ section.url }}"> &emsp;{{ section.title }} </a>
+        {% else %}
+            <a class="selected" href="{{site.baseurl}}{{ section.url }}"> &emsp;{{ section.title }} </a>
+        {% endif %}
+    {% endfor %}
+    <li>Scenario</li>
+    {% for section in site.scenarios %}
+        {% if section.section != page.section %}
+            <a href="{{site.baseurl}}{{ section.url }}"> &emsp;{{ section.title }} </a>
+        {% else %}
+            <a class="selected" href="{{site.baseurl}}{{ section.url }}"> &emsp;{{ section.title }} </a>
+        {% endif %}
+    {% endfor %}
+</div>
+
+# **Covariates**
+
+The **Covariates** tab is a *Project Datasheet*.
+
+In the SyncroSim UI, it can be accessed by right-clicking on a **WISDM** *Project*, selecting *Properties* from the context menu, and navigating to the *Covariates* tab.
+
+<br>
+
+### **Covariate Name**
+Provides a name for the covariate. The *Covariate Name* is used by the **Site Data** *Datasheet* under the [**Variable Reduction**](variable-reduction#heading01) tab.  
+
+### **Is Categorical**
+*Optional*. Determines whether the covariate is factor-based ("Yes"). 
+
+<div class=indentation> 
+    <i>Default:</i> No.
+</div>
+
+### **Description**
+*Optional*. Provides a description of the covariate.
+
+### **ID**
+*Optional*. Sets the site IDs for each covariate.
+
+### **Color**
+*Optional*. Defines a color for each covariate.
+
+<br>
diff --git a/docs/_sections/section2.md → docs/_scenarios/section2.md b/docs/_sections/section2.md → docs/_scenarios/section2.md
@@ -7,16 +7,35 @@ permalink: reference/data-preparation
 
 <!--- Sidebar Navigation Menu --->
 <div class="sidenav">
-    {% for section in site.sections %}
-        <a href="{{site.baseurl}}{{ section.url }}"> <b>{{ section.title }}</b> </a>
-        {% if section.section == page.section %}
-            <a href="#heading01"> &emsp;Template Raster</a>
-            <a href="#heading02"> &emsp;Covariate Data</a>
-            <a href="#heading03"> &emsp;Field Data</a>
-            <a href="#heading04"> &emsp;Field Data Options</a>
-            <a href="#heading05"> &emsp;Background Data Options</a>
-            <a href="#heading06"> &emsp;Validation Options</a>
-            <a href="#heading07"> &emsp;Spatial Multiprocessing</a>
+    <li>Library</li>
+    {% for section in site.library %}
+        {% if section.section != page.section %}
+            <a href="{{site.baseurl}}{{ section.url }}"> &emsp;{{ section.title }} </a>
+        {% else %}
+            <a class="selected" href="{{site.baseurl}}{{ section.url }}"> &emsp;{{ section.title }} </a>
+        {% endif %}
+    {% endfor %}
+    <li>Project</li>
+    {% for section in site.project %}
+        {% if section.section != page.section %}
+            <a href="{{site.baseurl}}{{ section.url }}"> &emsp;{{ section.title }} </a>
+        {% else %}
+            <a class="selected" href="{{site.baseurl}}{{ section.url }}"> &emsp;{{ section.title }} </a>
+        {% endif %}
+    {% endfor %}
+    <li>Scenario</li>
+    {% for section in site.scenarios %}
+        {% if section.section != page.section %}
+            <a href="{{site.baseurl}}{{ section.url }}"> &emsp;{{ section.title }} </a>
+        {% else %}
+            <a class="selected" href="{{site.baseurl}}{{ section.url }}"> &emsp;{{ section.title }} </a>
+            <a href="#heading01"> &emsp;&emsp;&emsp;Template Raster</a>
+            <a href="#heading02"> &emsp;&emsp;&emsp;Covariate Data</a>
+            <a href="#heading03"> &emsp;&emsp;&emsp;Field Data</a>
+            <a href="#heading04"> &emsp;&emsp;&emsp;Field Data Options</a>
+            <a href="#heading05"> &emsp;&emsp;&emsp;Background Data Options</a>
+            <a href="#heading06"> &emsp;&emsp;&emsp;Validation Options</a>
+            <a href="#heading07"> &emsp;&emsp;&emsp;Spatial Multiprocessing</a>
         {% endif %}
     {% endfor %}
 </div>

diff --git a/docs/_sections/section3.md → docs/_scenarios/section3.md b/docs/_sections/section3.md → docs/_scenarios/section3.md
@@ -7,12 +7,31 @@ permalink: reference/general
 
 <!--- Sidebar Navigation Menu --->
 <div class="sidenav">
-    {% for section in site.sections %}
-        <a href="{{site.baseurl}}{{ section.url }}"> <b>{{ section.title }}</b> </a>
-        {% if section.section == page.section %}
-            <a href="#heading01"> &emsp;Summary</a>
-            <a href="#heading02"> &emsp;Pipeline</a>
-            <a href="#heading03"> &emsp;Datafeeds</a>
+    <li>Library</li>
+    {% for section in site.library %}
+        {% if section.section != page.section %}
+            <a href="{{site.baseurl}}{{ section.url }}"> &emsp;{{ section.title }} </a>
+        {% else %}
+            <a class="selected" href="{{site.baseurl}}{{ section.url }}"> &emsp;{{ section.title }} </a>
+        {% endif %}
+    {% endfor %}
+    <li>Project</li>
+    {% for section in site.project %}
+        {% if section.section != page.section %}
+            <a href="{{site.baseurl}}{{ section.url }}"> &emsp;{{ section.title }} </a>
+        {% else %}
+            <a class="selected" href="{{site.baseurl}}{{ section.url }}"> &emsp;{{ section.title }} </a>
+        {% endif %}
+    {% endfor %}
+    <li>Scenario</li>
+    {% for section in site.scenarios %}
+        {% if section.section != page.section %}
+            <a href="{{site.baseurl}}{{ section.url }}"> &emsp;{{ section.title }} </a>
+        {% else %}
+            <a class="selected" href="{{site.baseurl}}{{ section.url }}"> &emsp;{{ section.title }} </a>
+            <a href="#heading01"> &emsp;&emsp;&emsp;Summary</a>
+            <a href="#heading02"> &emsp;&emsp;&emsp;Pipeline</a>
+            <a href="#heading03"> &emsp;&emsp;&emsp;Datafeeds</a>
         {% endif %}
     {% endfor %}
 </div>

diff --git a/docs/_sections/section4.md → docs/_scenarios/section4.md b/docs/_sections/section4.md → docs/_scenarios/section4.md
@@ -5,15 +5,33 @@ title: Variable Reduction
 permalink: reference/variable-reduction
 ---
 
-
 <!--- Sidebar Navigation Menu --->
 <div class="sidenav">
-    {% for section in site.sections %}
-        <a href="{{site.baseurl}}{{ section.url }}"> <b>{{ section.title }}</b> </a>
-        {% if section.section == page.section %}
-            <a href="#heading01"> &emsp;Site Data</a>
-            <a href="#heading02"> &emsp;Covariate Selection Options</a>
-            <a href="#heading03"> &emsp;Reduced Covariate List</a>
+    <li>Library</li>
+    {% for section in site.library %}
+        {% if section.section != page.section %}
+            <a href="{{site.baseurl}}{{ section.url }}"> &emsp;{{ section.title }} </a>
+        {% else %}
+            <a class="selected" href="{{site.baseurl}}{{ section.url }}"> &emsp;{{ section.title }} </a>
+        {% endif %}
+    {% endfor %}
+    <li>Project</li>
+    {% for section in site.project %}
+        {% if section.section != page.section %}
+            <a href="{{site.baseurl}}{{ section.url }}"> &emsp;{{ section.title }} </a>
+        {% else %}
+            <a class="selected" href="{{site.baseurl}}{{ section.url }}"> &emsp;{{ section.title }} </a>
+        {% endif %}
+    {% endfor %}
+    <li>Scenario</li>
+    {% for section in site.scenarios %}
+        {% if section.section != page.section %}
+            <a href="{{site.baseurl}}{{ section.url }}"> &emsp;{{ section.title }} </a>
+        {% else %}
+            <a class="selected" href="{{site.baseurl}}{{ section.url }}"> &emsp;{{ section.title }} </a>
+            <a href="#heading01"> &emsp;&emsp;&emsp;Site Data</a>
+            <a href="#heading02"> &emsp;&emsp;&emsp;Covariate Selection Options</a>
+            <a href="#heading03"> &emsp;&emsp;&emsp;Reduced Covariate List</a>
         {% endif %}
     {% endfor %}
 </div>

diff --git a/docs/_sections/section5.md → docs/_scenarios/section5.md b/docs/_sections/section5.md → docs/_scenarios/section5.md
@@ -7,13 +7,32 @@ permalink: reference/models
 
 <!--- Sidebar Navigation Menu --->
 <div class="sidenav">
-    {% for section in site.sections %}
-        <a href="{{site.baseurl}}{{ section.url }}"> <b>{{ section.title }}</b> </a>
-        {% if section.section == page.section %}
-            <a href="#heading01"> &emsp;GLM</a>
-            <a href="#heading02"> &emsp;Random Forest</a>
-            <a href="#heading03"> &emsp;Maxent</a>
-            <a href="#heading04"> &emsp;Model Outputs</a>
+    <li>Library</li>
+    {% for section in site.library %}
+        {% if section.section != page.section %}
+            <a href="{{site.baseurl}}{{ section.url }}"> &emsp;{{ section.title }} </a>
+        {% else %}
+            <a class="selected" href="{{site.baseurl}}{{ section.url }}"> &emsp;{{ section.title }} </a>
+        {% endif %}
+    {% endfor %}
+    <li>Project</li>
+    {% for section in site.project %}
+        {% if section.section != page.section %}
+            <a href="{{site.baseurl}}{{ section.url }}"> &emsp;{{ section.title }} </a>
+        {% else %}
+            <a class="selected" href="{{site.baseurl}}{{ section.url }}"> &emsp;{{ section.title }} </a>
+        {% endif %}
+    {% endfor %}
+    <li>Scenario</li>
+    {% for section in site.scenarios %}
+        {% if section.section != page.section %}
+            <a class="indent1" href="{{site.baseurl}}{{ section.url }}"> &emsp;{{ section.title }} </a>
+        {% else %}
+            <a class="selected" href="{{site.baseurl}}{{ section.url }}"> &emsp;{{ section.title }} </a>
+            <a href="#heading01"> &emsp;&emsp;&emsp;GLM</a>
+            <a href="#heading02"> &emsp;&emsp;&emsp;Random Forest</a>
+            <a href="#heading03"> &emsp;&emsp;&emsp;Maxent</a>
+            <a href="#heading04"> &emsp;&emsp;&emsp;Model Outputs</a>
         {% endif %}
     {% endfor %}
 </div>

diff --git a/docs/_sections/section6.md → docs/_scenarios/section6.md b/docs/_sections/section6.md → docs/_scenarios/section6.md
@@ -7,8 +7,29 @@ permalink: reference/output-options
 
 <!--- Sidebar Navigation Menu --->
 <div class="sidenav">
-    {% for section in site.sections %}
-        <a href="{{site.baseurl}}{{ section.url }}"> <b>{{ section.title }}</b> </a>
+    <li>Library</li>
+    {% for section in site.library %}
+        {% if section.section != page.section %}
+            <a href="{{site.baseurl}}{{ section.url }}"> &emsp;{{ section.title }} </a>
+        {% else %}
+            <a class="selected" href="{{site.baseurl}}{{ section.url }}"> &emsp;{{ section.title }} </a>
+        {% endif %}
+    {% endfor %}
+    <li>Project</li>
+    {% for section in site.project %}
+        {% if section.section != page.section %}
+            <a href="{{site.baseurl}}{{ section.url }}"> &emsp;{{ section.title }} </a>
+        {% else %}
+            <a class="selected" href="{{site.baseurl}}{{ section.url }}"> &emsp;{{ section.title }} </a>
+        {% endif %}
+    {% endfor %}
+    <li>Scenario</li>
+    {% for section in site.scenarios %}
+        {% if section.section != page.section %}
+            <a class="indent1" href="{{site.baseurl}}{{ section.url }}"> &emsp;{{ section.title }} </a>
+        {% else %}
+            <a class="selected" href="{{site.baseurl}}{{ section.url }}"> &emsp;{{ section.title }} </a>
+        {% endif %}
     {% endfor %}
 </div>
 

diff --git a/docs/_sections/section1.md b/docs/_sections/section1.md