From 62c714de66223fb7f1ac83902faca3bd48443e0a Mon Sep 17 00:00:00 2001 From: Carina-Firkowski Date: Wed, 1 Nov 2023 14:03:58 -0400 Subject: [PATCH] Update side navbar by datasheet scope --- docs/_config.yml | 9 +- .../section0.md => _library/library0.md} | 25 +++++- docs/_project/project1.md | 63 ++++++++++++++ docs/{_sections => _scenarios}/section2.md | 39 ++++++--- docs/{_sections => _scenarios}/section3.md | 31 +++++-- docs/{_sections => _scenarios}/section4.md | 32 +++++-- docs/{_sections => _scenarios}/section5.md | 33 ++++++-- docs/{_sections => _scenarios}/section6.md | 25 +++++- docs/_sections/section1.md | 44 ---------- docs/assets/main.scss | 83 +++++++++++++------ docs/reference.md | 17 ++-- 11 files changed, 289 insertions(+), 112 deletions(-) rename docs/{_sections/section0.md => _library/library0.md} (55%) create mode 100644 docs/_project/project1.md rename docs/{_sections => _scenarios}/section2.md (88%) rename docs/{_sections => _scenarios}/section3.md (81%) rename docs/{_sections => _scenarios}/section4.md (73%) rename docs/{_sections => _scenarios}/section5.md (82%) rename docs/{_sections => _scenarios}/section6.md (63%) delete mode 100644 docs/_sections/section1.md diff --git a/docs/_config.yml b/docs/_config.yml index 600d629..196a548 100644 --- a/docs/_config.yml +++ b/docs/_config.yml @@ -7,5 +7,10 @@ header_pages: - getting_started.md - reference.md collections: - sections: - output: true \ No newline at end of file + scenarios: + output: true + library: + output: true + project: + output: true + \ No newline at end of file diff --git a/docs/_sections/section0.md b/docs/_library/library0.md similarity index 55% rename from docs/_sections/section0.md rename to docs/_library/library0.md index 6797aa4..5f27779 100644 --- a/docs/_sections/section0.md +++ b/docs/_library/library0.md @@ -7,9 +7,28 @@ permalink: reference/network
- {% for section in site.sections %} - {{ section.title }} - {% if section.section == page.section %} +
  • Library
    • + {% for section in site.library %} + {% if section.section != page.section %} +  {{ section.title }} + {% else %} +  {{ section.title }} + {% endif %} + {% endfor %} +
  • Project
    • + {% for section in site.project %} + {% if section.section != page.section %} +  {{ section.title }} + {% else %} +  {{ section.title }} + {% endif %} + {% endfor %} +
  • Scenario
    • + {% for section in site.scenarios %} + {% if section.section != page.section %} +  {{ section.title }} + {% else %} +  {{ section.title }} {% endif %} {% endfor %}
    diff --git a/docs/_project/project1.md b/docs/_project/project1.md new file mode 100644 index 0000000..27668fb --- /dev/null +++ b/docs/_project/project1.md @@ -0,0 +1,63 @@ +--- +layout: default +section: 1 +title: Covariates +permalink: reference/covariates +--- + + +
    +
  • Library
    • + {% for section in site.library %} + {% if section.section != page.section %} +  {{ section.title }} + {% else %} +  {{ section.title }} + {% endif %} + {% endfor %} +
  • Project
    • + {% for section in site.project %} + {% if section.section != page.section %} +  {{ section.title }} + {% else %} +  {{ section.title }} + {% endif %} + {% endfor %} +
  • Scenario
    • + {% for section in site.scenarios %} + {% if section.section != page.section %} +  {{ section.title }} + {% else %} +  {{ section.title }} + {% endif %} + {% endfor %} +
    + +# **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. + +
    + +### **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"). + +
    + Default: No. +
    + +### **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. + +
    \ No newline at end of file diff --git a/docs/_sections/section2.md b/docs/_scenarios/section2.md similarity index 88% rename from docs/_sections/section2.md rename to docs/_scenarios/section2.md index 1a8c786..7b3c953 100644 --- a/docs/_sections/section2.md +++ b/docs/_scenarios/section2.md @@ -7,16 +7,35 @@ permalink: reference/data-preparation
    - {% for section in site.sections %} - {{ section.title }} - {% if section.section == page.section %} -  Template Raster -  Covariate Data -  Field Data -  Field Data Options -  Background Data Options -  Validation Options -  Spatial Multiprocessing +
  • Library
    • + {% for section in site.library %} + {% if section.section != page.section %} +  {{ section.title }} + {% else %} +  {{ section.title }} + {% endif %} + {% endfor %} +
  • Project
    • + {% for section in site.project %} + {% if section.section != page.section %} +  {{ section.title }} + {% else %} +  {{ section.title }} + {% endif %} + {% endfor %} +
  • Scenario
    • + {% for section in site.scenarios %} + {% if section.section != page.section %} +  {{ section.title }} + {% else %} +  {{ section.title }} +    Template Raster +    Covariate Data +    Field Data +    Field Data Options +    Background Data Options +    Validation Options +    Spatial Multiprocessing {% endif %} {% endfor %}
    diff --git a/docs/_sections/section3.md b/docs/_scenarios/section3.md similarity index 81% rename from docs/_sections/section3.md rename to docs/_scenarios/section3.md index f24db83..c370add 100644 --- a/docs/_sections/section3.md +++ b/docs/_scenarios/section3.md @@ -7,12 +7,31 @@ permalink: reference/general
    - {% for section in site.sections %} - {{ section.title }} - {% if section.section == page.section %} -  Summary -  Pipeline -  Datafeeds +
  • Library
    • + {% for section in site.library %} + {% if section.section != page.section %} +  {{ section.title }} + {% else %} +  {{ section.title }} + {% endif %} + {% endfor %} +
  • Project
    • + {% for section in site.project %} + {% if section.section != page.section %} +  {{ section.title }} + {% else %} +  {{ section.title }} + {% endif %} + {% endfor %} +
  • Scenario
    • + {% for section in site.scenarios %} + {% if section.section != page.section %} +  {{ section.title }} + {% else %} +  {{ section.title }} +    Summary +    Pipeline +    Datafeeds {% endif %} {% endfor %}
    diff --git a/docs/_sections/section4.md b/docs/_scenarios/section4.md similarity index 73% rename from docs/_sections/section4.md rename to docs/_scenarios/section4.md index 4c34983..9d48e9f 100644 --- a/docs/_sections/section4.md +++ b/docs/_scenarios/section4.md @@ -5,15 +5,33 @@ title: Variable Reduction permalink: reference/variable-reduction --- -
    - {% for section in site.sections %} - {{ section.title }} - {% if section.section == page.section %} -  Site Data -  Covariate Selection Options -  Reduced Covariate List +
  • Library
    • + {% for section in site.library %} + {% if section.section != page.section %} +  {{ section.title }} + {% else %} +  {{ section.title }} + {% endif %} + {% endfor %} +
  • Project
    • + {% for section in site.project %} + {% if section.section != page.section %} +  {{ section.title }} + {% else %} +  {{ section.title }} + {% endif %} + {% endfor %} +
  • Scenario
    • + {% for section in site.scenarios %} + {% if section.section != page.section %} +  {{ section.title }} + {% else %} +  {{ section.title }} +    Site Data +    Covariate Selection Options +    Reduced Covariate List {% endif %} {% endfor %}
    diff --git a/docs/_sections/section5.md b/docs/_scenarios/section5.md similarity index 82% rename from docs/_sections/section5.md rename to docs/_scenarios/section5.md index 3b59c0d..c559120 100644 --- a/docs/_sections/section5.md +++ b/docs/_scenarios/section5.md @@ -7,13 +7,32 @@ permalink: reference/models
    - {% for section in site.sections %} - {{ section.title }} - {% if section.section == page.section %} -  GLM -  Random Forest -  Maxent -  Model Outputs +
  • Library
    • + {% for section in site.library %} + {% if section.section != page.section %} +  {{ section.title }} + {% else %} +  {{ section.title }} + {% endif %} + {% endfor %} +
  • Project
    • + {% for section in site.project %} + {% if section.section != page.section %} +  {{ section.title }} + {% else %} +  {{ section.title }} + {% endif %} + {% endfor %} +
  • Scenario
    • + {% for section in site.scenarios %} + {% if section.section != page.section %} +  {{ section.title }} + {% else %} +  {{ section.title }} +    GLM +    Random Forest +    Maxent +    Model Outputs {% endif %} {% endfor %}
    diff --git a/docs/_sections/section6.md b/docs/_scenarios/section6.md similarity index 63% rename from docs/_sections/section6.md rename to docs/_scenarios/section6.md index 3c4ac04..68a1baa 100644 --- a/docs/_sections/section6.md +++ b/docs/_scenarios/section6.md @@ -7,8 +7,29 @@ permalink: reference/output-options
    - {% for section in site.sections %} - {{ section.title }} +
  • Library
    • + {% for section in site.library %} + {% if section.section != page.section %} +  {{ section.title }} + {% else %} +  {{ section.title }} + {% endif %} + {% endfor %} +
  • Project
    • + {% for section in site.project %} + {% if section.section != page.section %} +  {{ section.title }} + {% else %} +  {{ section.title }} + {% endif %} + {% endfor %} +
  • Scenario
    • + {% for section in site.scenarios %} + {% if section.section != page.section %} +  {{ section.title }} + {% else %} +  {{ section.title }} + {% endif %} {% endfor %}
    diff --git a/docs/_sections/section1.md b/docs/_sections/section1.md deleted file mode 100644 index 0f4bac2..0000000 --- a/docs/_sections/section1.md +++ /dev/null @@ -1,44 +0,0 @@ ---- -layout: default -section: 1 -title: Covariates -permalink: reference/covariates ---- - - -
    - {% for section in site.sections %} - {{ section.title }} - {% if section.section == page.section %} - {% endif %} - {% endfor %} -
    - -# **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. - -
    - -### **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"). - -
    - Default: No. -
    - -### **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. - -
    \ No newline at end of file diff --git a/docs/assets/main.scss b/docs/assets/main.scss index 94704cd..195009e 100644 --- a/docs/assets/main.scss +++ b/docs/assets/main.scss @@ -3,12 +3,12 @@ @import "minima"; -/* Color of links and other bits an bolts of the website set as the same than on SyncroSim website */ +// Color of links and other bits an bolts of the website set as the same than on SyncroSim website :root { --apexOrange: #175cb6; } -/* Links */ +// Links a { color: var(--apexOrange); } @@ -43,20 +43,20 @@ a { // Avoid wrapping of email address .contact-list .u-email { font-size: 95%; } -// size of wrapper +// Size of wrapper .wrapper { max-width: calc(1000px - (30px * 2)); padding-right: 15%; padding-left: 10%; } -/* Size of page content (text within page) */ +// Size of page content (text within page) .page-content { padding-right: 15%; padding-left: 10%; } -/* Alignment of footer */ +// Alignment of footer .site-footer{ padding-right: 15%; padding-left: 10%; @@ -68,27 +68,37 @@ a { margin-left: 0%; margin-right: 0%; } - .footer-col-2 { width: calc(40% - (30px / 2)); } - .footer-col-3 { width: calc(25% - (30px / 2)); text-align: right; } -/* Sidebar box */ +// Change footer col sizes +.footer-col-1 { + width: calc(50% - (30px / 2)); +} +.footer-col-2 { + width: calc(0% - (30px / 2)); +} +.footer-col-3 { + width: calc(50% - (30px / 2)); +} + + +// Sidebar box .sidenav { - width: 14%; + width: 18%; position: fixed; - top: 170px; + top: 125px; right: 0px; background: #f1f1f1; padding: 12px 12px; display: inline-block; } -/* Sidebar when link is selected */ +/* Link */ .sidenav a { padding: 6px 6px 6px 12px; text-decoration: none; @@ -96,31 +106,52 @@ a { color: #000; display: block; } -/* Sidebar when cursor hovers */ +/* Link on focus */ +.sidenav a:focus { + font-weight: 700; + background-color:#fff; + color: #000; +} +/* Link on hover */ .sidenav a:hover { - background-color:#cecece; - color: white; + background-color:#fff; + color: #000; } -/* Adjust for small screens */ -@media screen and (max-width: 500px) { +/* Link when selected (active page) */ +.selected { + font-weight: 700; + background-color:#fff; + color: #000; +} +/* Remove sidebar on small screens */ +@media screen and (max-width: 1130px) { .sidenav {display: none;} } +/* Lists */ +.sidenav li { + padding: 6px 6px 6px 12px; + text-decoration: none; + font-size: 12px; + font-weight: 700; + color: #000; + display: block; +} -/* Indented text */ + +// Indented text .indentation { margin-left: 2rem; margin-bottom: 1rem; } -// Change footer col sizes -.footer-col-1 { - width: calc(50% - (30px / 2)); -} - -.footer-col-2 { - width: calc(0% - (30px / 2)); +// List with no bullet icon +.no-bullets { + list-style-type: none; + padding: 0; + margin: 0; } -.footer-col-3 { - width: calc(50% - (30px / 2)); +// Spacer smaller than
    +.spacer { + height: 12px; } diff --git a/docs/reference.md b/docs/reference.md index 3c56452..75ad23e 100644 --- a/docs/reference.md +++ b/docs/reference.md @@ -11,10 +11,17 @@ In SyncroSim, all of the of inputs and outputs associated with a model are store **WISDM** has a *Library*, a *Project* and multiple *Scenario* scoped *Datasheets*. Within this Reference guide, you will find details on the function of each field within **WISDM** *Datasheets*. For details on *Datasheets* not covered in this reference guide, see the [SyncroSim Core Datasheets Overview](https://docs.syncrosim.com/?reference/ds_overview.html). -**WISDM** *Datasheets* are organized under the following tabs: - -{% for section in site.sections %} +
  • Library Datasheet:
    • +{% for section in site.library %}
  • {{ section.title }}
    • {% endfor %} - -
    \ No newline at end of file +
    +
  • Project Datasheet:
    • +{% for section in site.project %} +
  • {{ section.title }}
    • +{% endfor %} +
    +
  • Scenario Datasheets:
    • +{% for section in site.scenarios %} +
  • {{ section.title }}
    • +{% endfor %} \ No newline at end of file