View source for TUEWAS Toolbox - User Guidance

{{Tabs-2
|Distribution_System_Operation_Toolbox|Toolbox
|TUEWAS_Toolbox_-_User_Guidance|User Guidance
}}
{{header banner portal
|image = icon-tuewas.svg
|headline = '''Distribution System Operation Toolbox'''
|teaser = [[File:TUEWAS-logo.png|center|200px|link=https://tuewas-asia.org/]]
----
<div class="header-banner-numbers">
<div class="header-banner-number" style="color:rgb(1,57,112)">'''{{#ask: [[Category:TUEWAS ToolboxDB]] |format=count}}''' database entries</div>
</div>
}}
<!--<center><big><span style="color:#FF0000;">''This user guidance is still work in progress!''</span></big></center>-->
<div class="grid">
<div class="width-1-3 box">
== Contents ==
</div>
<div class="width-1-3">
</div>
<div class="width-1-3">
</div>
<div class="width-1-3 card">
[[#1._Category_Structure|1. Category Structure]]<br/>
[[#2._Web-based_Toolbox_Database|2. Web-based Toolbox Database]]<br/>
[[#3._Toolbox_Navigation|3. Toolbox Navigation]]<br/>
[[#4._Conducting_a_Search|4. Conducting a Search]]<br/>
[[#5._Adding_an_Entry_to_the_Database|5. Adding an Entry to the Database]]<br/>
[[#6._Editing_and_Deleting_Entries|6. Editing and Deleting Entries]]
</div>
<div class="width-1-3">
</div>
<div class="width-1-3">
</div>
</div> <!-- End .grid -->

== 1. Category Structure ==

The category structure allows the storing of files according to categories. Eight categories have been defined in the current version of the Toolbox (Figure 1). Each file is assigned one main category (which also determines in which overview page the file is stored). With the use of key words, which are defined for each category (Figure 2), the search options can be expanded beyond the main categories. This will be further detailed in [[#4._Conducting_a_Search|Section 4]].
<div class="grid">
<div class="width-1-2">
[[File:Tuewas-fig-0.png|link=|center|900x900px]]
<center>'''Figure 1. Main Categories'''</center>
</div>
<div class="width-2-4">
[[File:Tuewas-fig-1.png|link=|center|500x500px]]
<center>'''Figure 2. Categories and Key Words of the Toolbox'''</center>
</div>
</div> <!-- End .grid -->

[[#Contents|►Go to Top]]

== 2. Web-based Toolbox Database ==

The Toolbox Database is a web-based platform that uses ask queries to allow the user to easily search for entries that have been added to the database system. It also allows the user to add new entries to the database and to make edits to individual database entries.
The Web-based toolbox consists of three main areas: 1) Toolbox, 2) Search, and 3) Database.
The Toolbox page (Figure 3) provides a description of it, as well as a link to the TUEWAS website. Next to that, the Toolbox page mainly acts as an interface that allows the user to access the different pages of the database, as well as the category structure.

[[File:Tuewas-fig-2.png|link=|center|800x800px]]
<center>'''Figure 3. Home Page of the Toolbox'''</center>

The Search mask (Figure 4 and 5) consists of an online form with data input fields that allow for a user-friendly filtering of the database. Fields are available for categories, author, year of publication, country and type of material. How to conduct a search is further detailed in [[#4._Conducting_a_Search|Section 4]].

<div class="grid">
<div class="width-1-4">
[[File:Tuewas-fig-3.png|link=|center|200x200px]]
<center>'''Figure 4. Search button'''</center>
</div>
<div class="width-3-4">
[[File:Tuewas-fig-4.png|link=|center|900x900px]]
<center>'''Figure 5. Search Mask'''</center>
</div>
</div> <!-- End .grid -->

The Database browse page (Figures 6 and 7)contains the entire list of documents that have been deposited in the filing system and provides detailed information about each file, including title, author, publication year, type of entry, category, country, etc. The database browse page also includes a link to add a new database entry (Figure 7), should the user not find the entry they were looking for immediately.

<div class="grid">
<div class="width-1-4">
[[File:Tuewas-fig-5.png|link=|center|200x200px]]
<center>'''Figure 6. Browse button'''</center>
</div>
<div class="width-3-4">
[[File:Tuewas-fig-6.png|link=|center|900x900px]]
<center>'''Figure 7. Entire database browse page and "Add entry" link'''</center>
</div>
</div> <!-- End .grid -->

[[#Contents|►Go to Top]]

== 3. Toolbox Navigation ==

From the Toolbox home page the user can access all the main functions of the Toolbox. The search, add and edit functions are further detailed in [[#4._Conducting_a_Search|Section 4]], [[#5._Adding_an_Entry_to_the_Database|Section 5]] and [[#6._Editing_and_Deleting_Entries|Section 6]], which are written in instruction style to be used in the User Guidance. From the Toolbox home page, the user can also navigate through the category structure directly and go to the User Guidance tab (Figure 8), in case they need further information on how to use the Toolbox (Figure 9).

<div class="grid">
<div class="width-1-2">
[[File:Tuewas-fig-7.png|link=|center|600x600px]]
<center>'''Figure 8. User Guidance tab'''</center>
</div>
<div class="width-1-2">
[[File:Tuewas-fig-8.png|link=|center|600x600px]]
<center>'''Figure 9. User Guidance page'''</center>
</div>
</div> <!-- End .grid -->

[[#Contents|►Go to Top]]

== 4. Conducting a Search ==

On the Toolbox tab, scroll down and click on the Search icon (see Figure 4). The user will be redirected to the Search mask (see Figure 5). 

In the search mask, you can filter entries from the database by entering data into different fields (fig.). There are 6 fields: 1) Title, 2) Author, 3) Year, 4) Country, 5) Type of Entry, 6) Main Category. The remaining 7 fields correspond to the Category structure, for which there are several checkboxes for each category. You can choose which way to best use the fields to find what you are looking for, i.e., there is no need to use all of them (Figure 10).

[[File:Tuewas-fig-9.png|link=|center|800x800px]]
<center>Figure 10. Applying filters to the search mask</center>

Each new field selected for filtering will add to the previously selected filtering criteria. For example, by selecting Viet Nam in the country field, as well as “Control solutions” and “Battery energy storage systems” in the category fields, the filtered results will be those for Vietnamese sources that are marked with both keywords.

The search results will display in a table at the bottom of the page (Figure 11). If no results are shown, it means there are no entries fulfilling all the selected criteria, so you will have to adjust the search by applying less or different criteria (Figure 12).

<div class="grid">
<div class="width-2-3">
[[File:Tuewas-fig-10.png|link=|center|900x900px]]
<center>'''Figure 11. Search results'''</center>
</div>
<div class="width-1-3">
[[File:Tuewas-fig-11.png|link=|center|800x800px]]
<center>'''Figure 12. No search results'''</center>
</div>
</div> <!-- End .grid -->

Click on the "Clear Form" link to clear the results in the table and start a new (fresh) search (Figure 13).

[[File:Tuewas-fig-12.png|link=|center|700x700px]]
<center>Figure 13. Clear Form</center>

Some of the text fields will suggest an existing data input so that the user search for existing entries only. E.g., if there is one entry with Benin as a country, and the user types "B" in the "Country" field, the field will suggest a list with all entries with countries starting with the letter "B". This way, the user can easily find entries that actually exist (Figure 14).

[[File:Tuewas-fig-13.png|link=|center|600x600px]]
<center>Figure 14. Autocomplete fields from existing data entries</center>

You can either choose to open the loaded files from the search table by clicking on "File" (if uploaded) or "URL" (if available). Alternatively, you can click on the link under “Title” to navigate to the database entry page and get more information on the filtered documents (Figure 15).

[[File:Tuewas-fig-14.png|link=|center|800x800px]]
<center>Figure 15. Navigating to the uploaded file and URL  </center>

== 5. Adding an Entry to the Database ==

You can expand the database by adding new files, allowing you to build your own personalised Toolbox over time.
To add a new file (a new database entry), you must click on the orange “Add” icon in the Toolbox tab, which will prompt a data entry form (Figure 16). 

Bear in mind that in order to be able to add new entries or information in general, you have to be logged-in. 

[[File:Tuewas-fig-15.png|link=|center|800x800px]]
<center>Figure 16. Add a new file (database entry)  </center>

To successfully add a new file, all fields that are marked with an asterisk (*) are mandatory (Figure 17). The choice of at least one category and one keyword is obligatory and you must assign the main category, which determines in which overview page the file (if you are uploading a file) will be saved. Other fields are optional. We do recommend adding as much information for each entry as possible to facilitate future filtering and use of the Toolbox. 

[[File:Tuewas-fig-16.png|link=|center|800x800px]]
<center>Figure 17. Mandatory fields</center>

Bear in mind that to select keywords from each category, you first have to select the desired main category or categories, in order for them to display a list of their keywords (Figure 18). Any category left unchecked will not display the list of their keywords and upon saving, the category will not appear in the page. Click "Save Page" to complete the data entry.

[[File:Tuewas-fig-17.png|link=|center|800x800px]]
<center>Figure 18. Select main category to see a list of its keywords</center>

== 6. Editing and Deleting Entries ==

To edit an entry, simply click on the desired category overview page in the Toolbox tab and locate the page in question (Figure 19).

[[File:Tuewas-fig-18.png|link=|center|800x800px]]
<center>Figure 19. Select main category to see an overview page of its entries </center>

Alternatively, you can browse the entire database by clicking on the orange "Browse entire database" icon (Figure 20), which will direct you to the entire database overview (Figure 21). 

<div class="grid">
<div class="width-1-4">
[[File:Tuewas-fig-19.png|link=|center|900x900px]]
<center>'''Figure 20. Browse entire database '''</center>
</div>
<div class="width-3-4">
[[File:Tuewas-fig-20.png|link=|center|800x800px]]
<center>'''Figure 21. Full database overview page '''</center>
</div>
</div> <!-- End .grid -->

Once you navigate to the desired page, simply click on the "Edit page" icon (Figure 22), and modify the corresponding information (Figure 23). Bear in mind that deletion of pages and files are actions reserved for users with administration permissions only. If you wish to delete a page, please get in touch with an administrator at [mailto:info@energypedia.info info@energypedia.info].

<div class="grid">
<div class="width-1-2">
[[File:Tuewas-fig-21.png|link=|center|900x900px]]
<center>'''Figure 22. Edit button (view mode) '''</center>
</div>
<div class="width-1-2">
[[File:Tuewas-fig-22.png|link=|center|800x800px]]
<center>'''Figure 23. Editing page (editing mode)'''</center>
</div>
</div> <!-- End .grid -->

{{#Widget:Heatmap}}

__NOAUTHORLIST__
__NOEDITSECTION__
__NOTOC__