Skip to content

Commit

Permalink
Updated the English forms and reports file.
Browse files Browse the repository at this point in the history
  • Loading branch information
@z3thon
z3thon committed Jan 9, 2023
1 parent 2dde15e commit 40a95d3
Show file tree
Hide file tree
Showing 5 changed files with 234 additions and 4 deletions.
13 changes: 13 additions & 0 deletions docs/en/Basics/5 Forms and Records.md
View file
Original file line number Diff line number Diff line change
@@ -1,5 +1,18 @@
# Forms and Records

Forms and Records are how you view, edit, and save your data in Sightline.

### Viewing Forms

When you want to view a form, click on the "eye" 👁️ icon next to the record you would like to view.

### Editing Forms

When you want to edit a form, click on the "pencil" ✏️ icon next to the record you would like to view.

### Saving Forms


In the two forms below one is for adding a new employee to your company and the other is for adding a new Part to the Elements App.

![New Employee](../../../overrides/assets/images/en/New_Employee.png)
Expand Down
70 changes: 67 additions & 3 deletions en/Basics/3 Apps & Tables/index.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -455,10 +455,48 @@



<label class="md-nav__link md-nav__link--active" for="__toc">
Apps & Tables
<span class="md-nav__icon md-icon"></span>
</label>

<a href="./" class="md-nav__link md-nav__link--active">
Apps & Tables
</a>



<nav class="md-nav md-nav--secondary" aria-label="Table of contents">






<label class="md-nav__title" for="__toc">
<span class="md-nav__icon md-icon"></span>
Table of contents
</label>
<ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>

<li class="md-nav__item">
<a href="#apps" class="md-nav__link">
Apps
</a>

</li>

<li class="md-nav__item">
<a href="#tables" class="md-nav__link">
Tables
</a>

</li>

</ul>

</nav>

</li>


Expand Down Expand Up @@ -1061,6 +1099,28 @@



<label class="md-nav__title" for="__toc">
<span class="md-nav__icon md-icon"></span>
Table of contents
</label>
<ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>

<li class="md-nav__item">
<a href="#apps" class="md-nav__link">
Apps
</a>

</li>

<li class="md-nav__item">
<a href="#tables" class="md-nav__link">
Tables
</a>

</li>

</ul>

</nav>
</div>
</div>
Expand All @@ -1075,9 +1135,13 @@


<h1 id="apps-tables">Apps &amp; Tables</h1>
<p>Each row on a report/table represents a single record. When you create a new record you will be redirected to a form that will prompt you to fill out the required information for that record. Each form represents a single record and because each table stores different information each form is also different. In the two forms below one is for adding a new employee to your company and the other is for adding a new Part to the Elements App.</p>
<p><img alt="New Employee" src="../../../overrides/assets/images/en/New_Employee.png" />
<img alt="New Element" src="../../../overrides/assets/images/en/New_Element.png" /></p>
<p>In Sightline we use Apps and the Tables within the apps to create the structure of the software.</p>
<h2 id="apps">Apps</h2>
<p>Each app in the Sightline suite connects to the other apps. Each app focuses on a specific purpose and function allowing you to focus on your work and stay productive. Each app is made of multiple tables and the tables hold your data. Each table in the navigation bar is unique to the app that you are using.</p>
<p>A single app may have 20 or 30 tables. Don't forget about the drop-down arrown on the right hand side to quickly find and search for a specific table in each app.</p>
<h2 id="tables">Tables</h2>
<p>Each row on a report/table represents a single record. When you create a new record you will be redirected to a form that will prompt you to fill out the required information for that record. Clicking the 👁️ on a single record will allow you to view all the data about that one record from a form view. Each form represents a single record on the table and because each table stores different information each form is also different.</p>
<p>Using grid edit 📝 on a table can be handy, but remember that the forms will always have the best formatting to edit the data and interact with the data on the record.</p>



Expand Down
70 changes: 70 additions & 0 deletions en/Basics/4 Table Reports and Exporting Reports/index.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -469,10 +469,48 @@



<label class="md-nav__link md-nav__link--active" for="__toc">
Reports and Exporting
<span class="md-nav__icon md-icon"></span>
</label>

<a href="./" class="md-nav__link md-nav__link--active">
Reports and Exporting
</a>



<nav class="md-nav md-nav--secondary" aria-label="Table of contents">






<label class="md-nav__title" for="__toc">
<span class="md-nav__icon md-icon"></span>
Table of contents
</label>
<ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>

<li class="md-nav__item">
<a href="#reports" class="md-nav__link">
Reports
</a>

</li>

<li class="md-nav__item">
<a href="#exporting" class="md-nav__link">
Exporting
</a>

</li>

</ul>

</nav>

</li>


Expand Down Expand Up @@ -1061,6 +1099,28 @@



<label class="md-nav__title" for="__toc">
<span class="md-nav__icon md-icon"></span>
Table of contents
</label>
<ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>

<li class="md-nav__item">
<a href="#reports" class="md-nav__link">
Reports
</a>

</li>

<li class="md-nav__item">
<a href="#exporting" class="md-nav__link">
Exporting
</a>

</li>

</ul>

</nav>
</div>
</div>
Expand All @@ -1075,6 +1135,16 @@


<h1 id="reports-and-exporting">Reports and Exporting</h1>
<p>Tables have lots of cool hidden supoer powers. Two of the most powerful are Reports and Exporting your reports as CSVs.</p>
<h2 id="reports">Reports</h2>
<p>Each Table can contain multiple reports. Each report has the data formatted in a specific way, or may also be a chart, like a pie chart or bar graph. Often the information on each report is for different purposes.</p>
<p>Each report has a use case that has been thought out by the team and the partners we are working with, but if you need a new report with the data formatted differently that doesn't currently exist reach out to us on our <a href="https://discord.gg/zNCZnKNXEv">Discord Community</a>.</p>
<p>We will do our best to keep updating reports as frequently as possible to keep them relevant and useful.</p>
<p>To view other reports use the "Reports &amp; Charts" drop-down and select the report you would like to view as shown in Navigation.</p>
<p><img alt="Reports" src="../../../overrides/assets/images/en/Reports.png" /></p>
<h2 id="exporting">Exporting</h2>
<p>When you need to manipulate the data beyond what is possible naitively in Sightline or you need to send the data to someone outside of the Sightline system you can download the report you are looking at as a CSV. Keep in mind if there are buttons on the form you are exporting, those buttons will show up at hyperlinks in the CSV once you open it. Many of our reports are designed to be exported and do not contain buttons specifically for this reason.</p>
<p>As mentioned above in the reports section if there is a specific report you need so that you can frequently export it as a CSV and use it for other purposes please reach out to us and let us know what you need.</p>



Expand Down
83 changes: 83 additions & 0 deletions en/Basics/5 Forms and Records/index.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -483,10 +483,55 @@



<label class="md-nav__link md-nav__link--active" for="__toc">
Forms and Records
<span class="md-nav__icon md-icon"></span>
</label>

<a href="./" class="md-nav__link md-nav__link--active">
Forms and Records
</a>



<nav class="md-nav md-nav--secondary" aria-label="Table of contents">






<label class="md-nav__title" for="__toc">
<span class="md-nav__icon md-icon"></span>
Table of contents
</label>
<ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>

<li class="md-nav__item">
<a href="#viewing-forms" class="md-nav__link">
Viewing Forms
</a>

</li>

<li class="md-nav__item">
<a href="#editing-forms" class="md-nav__link">
Editing Forms
</a>

</li>

<li class="md-nav__item">
<a href="#saving-forms" class="md-nav__link">
Saving Forms
</a>

</li>

</ul>

</nav>

</li>


Expand Down Expand Up @@ -1061,6 +1106,35 @@



<label class="md-nav__title" for="__toc">
<span class="md-nav__icon md-icon"></span>
Table of contents
</label>
<ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>

<li class="md-nav__item">
<a href="#viewing-forms" class="md-nav__link">
Viewing Forms
</a>

</li>

<li class="md-nav__item">
<a href="#editing-forms" class="md-nav__link">
Editing Forms
</a>

</li>

<li class="md-nav__item">
<a href="#saving-forms" class="md-nav__link">
Saving Forms
</a>

</li>

</ul>

</nav>
</div>
</div>
Expand All @@ -1075,6 +1149,15 @@


<h1 id="forms-and-records">Forms and Records</h1>
<p>Forms and Records are how you view, edit, and save your data in Sightline.</p>
<h3 id="viewing-forms">Viewing Forms</h3>
<p>When you want to view a form, click on the "eye" 👁️ icon next to the record you would like to view.</p>
<h3 id="editing-forms">Editing Forms</h3>
<p>When you want to edit a form, click on the "pencil" ✏️ icon next to the record you would like to view.</p>
<h3 id="saving-forms">Saving Forms</h3>
<p>In the two forms below one is for adding a new employee to your company and the other is for adding a new Part to the Elements App.</p>
<p><img alt="New Employee" src="../../../overrides/assets/images/en/New_Employee.png" />
<img alt="New Element" src="../../../overrides/assets/images/en/New_Element.png" /></p>



Expand Down
2 changes: 1 addition & 1 deletion en/search/search_index.json
View file

Large diffs are not rendered by default.

0 comments on commit 40a95d3

Please sign in to comment.