Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

add help text for setup wizard pages #340

Merged
merged 2 commits into from
Dec 2, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
<p>
<p class="mb-2">
If NEBs are found that cannot be associated with a <span class="bold">specific</span> energy efficiency opportunity,
then they should be added
here.
Expand All @@ -9,7 +9,7 @@
equipment or meet a secondary goal.
</p>
<hr>
<p>
<p class="mb-2">
Non-Energy Benefits can be added to assessment with the "<fa-icon [icon]="faPlus"></fa-icon> Add NEB" button.
</p>
<p>
Expand All @@ -27,13 +27,13 @@
</li>
</ol>
<hr>
<p>
<p class="mb-2">
Once a NEB is entered, <span class="bold">"Key Performance Metric Impacts"</span> can be added. These are impacts
that
the NEB has on
performance metrics the company is tracking.
</p>
<p>
<p class="mb-2">
The "<fa-icon [icon]="faSearchPlus"></fa-icon> Search Key Performance Metrics" button will open a modal with a list
of
all performance metrics in the tool. If a metric is known to be typically associated with the NEB, it will be
Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,18 @@
<p>
Enter stakeholder details of people that will be invested in the companies quest to find Non-Energy Benefits!
</p>
<hr>
<p>

These are people who could help gather data regarding Key Performance Indicators and Metrics (KPIs and KPMs), energy
use, or would be interested in results.
</p>
<hr>
<p>
This information can be used to help get in contact with these individuals later on in the process.
</p>
<hr>
<p>
Stakeholders can be attached to KPIs, NEBs, Industrial Systems, and End Uses.
</p>
<hr>
Original file line number Diff line number Diff line change
@@ -1,13 +1,13 @@
<p>
<p class="mb-2">
<span class="bold">Key Performance Indicators (KPI)</span> and <span class="bold">Key Performance Metrics
(KPMs)</span>
</p>
<p>
<p class="mb-2">
<span class="bold">Key Performance Indicators (KPI)</span> are the critical (key) quantifiable indicators of
progress toward an intended
result and are used to track progress towards business objectives.
</p>
<p>
<p class="mb-2">
<span class="bold">Key Performance Metrics
(KPMs)</span> refers to quantifiable measurements an organization uses to track performance.
</p>
Expand Down
Original file line number Diff line number Diff line change
@@ -1,13 +1,13 @@
<p>
<p class="mb-2">
<span class="bold">Key Performance Indicators (KPI)</span> and <span class="bold">Key Performance Metrics
(KPMs)</span>
</p>
<p>
<p class="mb-2">
<span class="bold">Key Performance Indicators (KPI)</span> are the critical (key) quantifiable indicators of
progress toward an intended
result and are used to track progress towards business objectives.
</p>
<p>
<p class="mb-2">
<span class="bold">Key Performance Metrics
(KPMs)</span> refers to quantifiable measurements an organization uses to track performance.
</p>
Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,13 @@
<p>
Provide details about the company
Provide details about the company.
</p>
<hr>
<p>
<span class="bold">Company Name</span> is the only required field, all others are optional.
</p>
<hr>
<p>
<span class="bold">Energy Results Unit</span> sets the roll up unit for combining energy results from different utilities. It defaults to
MMBtu.
</p>
<hr>
Original file line number Diff line number Diff line change
@@ -1,4 +1,12 @@
<p>
Add end uses to the inventory for the selected facility.
</p>
<hr>
<p>
Name and make notes about end uses of outputs of the Industrial Systems.
</p>
<hr>
<p>
Click the <span class="bold">Stakeholders</span> button to connect stakeholders to the equipment.
</p>
<hr>
Original file line number Diff line number Diff line change
@@ -1,4 +1,48 @@
<p>
Add equipment to the "Industrial System Inventory" for the selected facility.
Add equipment to the "Industrial System Inventory" for the selected facility.</p>
<hr>
<p>
This inventory focuses on equipment related to assessments that are being conducted: larger motor driven systems
(pumps, fans, compressors), process heating equipment, steam equipment. Systems like lighting equipment, HVAC
systems, and mobile equipment can also be tracked.
</p>
<hr>
<p>
Setting the <span class="bold">"Industrial System"</span> sets the energy-related fields in the form.
</p>
<hr>
<p>
<span class="bold">Utility Type</span> sets the units available for <span class="bold">Total
Size</span>.
</p>
<hr>
<p>
Enter nameplate data for <span class="bold">Total Size</span> to begin estimating the energy used by the system.
</p>
<hr>
<p>
<span class="bold">Operating Hours</span> refers to the hours the equipment (not the entire facility) is operating.
</p>
<hr>
<p>
<span class="bold">Load Factor</span> refers to the fraction of the nameplate size power that is being used.
</p>
<hr>
<p>
<span class="bold">Efficiency</span> refers to the energy efficiency of the equipment.
</p>
<hr>
<p>
<span class="bold">Number of Equipment</span> can be utilized if multiple equipment is about the same size.
</p>
<hr>
<p>
<span class="bold">Notes</span> can be used to help start to take notes about the equipment and how it connects to
end users and potential
NEBs.
</p>
<hr>
<p>
Click the <span class="bold">Stakeholders</span> button to connect stakeholders to the equipment.
</p>
<hr>
Original file line number Diff line number Diff line change
@@ -1,4 +1,23 @@
<p>
Provide details about the facility
Provide details about the facility.
</p>
<hr>
<p>
<span class="bold">Facility Name</span> is the only required field, all others are optional. Tracked Utilities is highly recommended.
</p>
<hr>
<p>
<span class="bold">Tracked Utilities</span> is the place to enter annual data regarding different utilities (electricity, natural gas, water,
etc.)
</p>
<hr>
<p>
Focus on utilities connected to the system being assessed (electricity for pumps, fans, motors, etc.; natural gas
for heating, steam, etc.).
</p>
<hr>
<p>
The "Compressed Air" and "Steam" utilities are used when compressed air and steam cross the facility fence and are
not produced on-site.
</p>
<hr>
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,14 @@
</p>
<hr>
<p>
Details about the results of the assessment can be entered during the data collection phase.
Details about the results of the assessment can also be entered during the data collection phase. In the
pre-assessment, this is a high level estimate of the annual energy used by the system being assessed. It will be
used to estimate the relative change in utility use caused by implementing the opportunities found in the assessment
(percent savings).
</p>
<hr>
<p>
If the assessment is a Treasure Hunt, please put in the facility-level annual use for any utility where savings may
be found. Units can be set independently.
</p>
<hr>
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
<p>
This page is coming soon. It will provide a rollup summary of all the assessments in the visit.
A rollup report of the assessments is provided. This report includes details about the impacts on individual KPMs
and simple payback periods for the assessments.
</p>
<hr>
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@


.panel-label{
display: inline-block;
display: inline-block !important;
line-height: normal;
overflow: hidden;
text-overflow: ellipsis;
Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
<div class="h-100 d-flex flex-column align-items-start justify-content-start shadow help-text help-container"
[ngClass]="{'collapsed': !helpPanelOpen}">
<div class="w-100 pb-1 d-flex">
<div class="toggle-collapse d-flex">
<div class="toggle-collapse d-flex w-100">
<a class="click-link" (click)="toggleCollapseHelpPanel()">
<fa-icon [icon]="faCircleQuestion"></fa-icon>
</a>
Expand Down
9 changes: 9 additions & 0 deletions src/assets/styles/helpText.css
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,15 @@
font-size: .875rem;
}

.help-text p{
margin-bottom: 0px;
}

.help-text .panel-label h5{
font-weight: 300;
}

.help-text hr{
margin-top: .5rem;
margin-bottom: .5rem;
}
Loading