User Tools

Site Tools


glossary

Glossary

Overview

The glossary is a user defined list of commonly used block names. It aims to solve the problem of naming - where blocks or quantities are referred to by different names and abbreviations in different projects (or even within the same project).

  • With a strict naming convention it is easier for a user or developer to understand what different blocks represent.
  • When working with the Parameter database or Excel, the name of the block is used to identify values. With a naming convention the same database or Excel files can be used for many different projects.

The glossary can also save you time. When you create a new block with a name which is listed in the glossary, Ecolego will automatically pull the corresponding full name, symbol, etc. from the glossary.

You edit the glossary by selecting File>Glossary. The editing window has two tabs; Glossary allows you to add new entries to the glossary and edit existing entries, where Match lets you synchronize the current project with the glossary.

Glossary

The table in the Glossary tab has initially only one (empty) row. Click in the Name column and enter the name of the glossary item. As you press ENTER a new empty row will appear, in which you can define the next entry.

Match

The Match tab allows you to synchronize a project with the glossary. Names from the glossary can be given to blocks in the model, and the names of blocks in the model can be added to the glossary.

Toolbar

The toolbar allows you to hide unimportant rows and select which block properties to include in the match. When you de-select properties, the corresponding columns are removed from the table.

  • Hide matched - Hide all blocks with a perfect (five star) match.
  • Hide uncommon types - Hide blocks which are less suitable for the glossary, such as influence, compartments etc.
  • Full name - Select to include the full name property in the match or de-select to ignore it.
  • Symbol - Select to include the symbol property in the match.
  • Unit - Select to include the unit in the match.
  • Category - Select to include the category in the match.
  • Description - Select to include the description in the match.

Table

The table lists all the blocks found in the current project. You can edit the name, full name etc. directly in the table.

  • Match - Shows how well a block matches the entries of the glossary.
Empty No matching entry was found in the glossary
The full name of the block was found in the glossary
The name of the block was found in the glossary but with a different case and/or underscores ('_')
The name of the block was as an alias to an entry in the glossary
The name of the block is identical to a name of an entry in the glossary, but the full name, symbol or description did not match
The blocks name, full name, symbol etc. matches an entry in the glossary exactly.
  • Item - The entry in the glossary with which a match was found
  • Block - Update - Assign all information in the glossary entry to the block.
  • Glossary - Add/Update - If unmatched, create a new entry in the glossary with the information from the block. Otherwise update the glossary entry with the information in the block.
  • Empty - The type of block
  • Name - The name of the block
  • Full name* - The full name of the block
  • Unit* - The unit of the block
  • Symbol* - The symbol of the block
  • Category* - The category of the block
  • Description* - The description of the block
  • The property columns are only visible if the property is included in the match. Use the toolbar buttons to include/exclude properties.

See also

glossary.txt · Last modified: 2019/11/18 13:34 (external edit)