Conventions Used in This Guide

Standards and Styles

The PoolParty documentation adheres to a couple of standards.

  • APA-Title case is used for headings.

  • We adhere to the standard of Simplified Technical English in our documents.

  • The concept of topic-based authoring is part of our internal style guides.

  • American English is the standard for all questions pertaining to language.

Typographical Conventions

The following typographical conventions are used in this guide:

  • American English as a language standard.

  • Font face: Bold, Title Case to indicate GUI elements like dialogues, tabs, button labels, etc.

Icons and Text-Boxes

23898884.pngTo mark all sections that contain technical details, which are not necessary to know for the day-to-day use of PoolParty, we use this bulb image.

Tip

Tips for working with PoolParty.

Note

Things you should know when you are working with PoolParty.

Caution

Things you should not do when you are working with PoolParty or things you cannot revoke once they are done.

Warning

Things that could lead to unexpected behaviour of PoolParty.

Danger

 

Notice

Important

PoolParty Default Icons

Icon

Name

Description

23898870.png

Add icon

Adds a new relation, label or definition

23898881.png

Delete icon

Deletes a relation, label or definition

23898876.png

Edit icon

Opens inline editing for an existing label or definition

23898878.png

Link icon

Opens a selection field to select other concepts to link to.

23898875.png

Draft icon

Depicts draft concepts.

23898873.png

Approval icon

Approve a concept or a concept suggestion.

23898880.png

Reject icon

Reject a concept suggestion.

23898868.png

History icon

Display the history of a concept.

23898877.png

Info icon

Display full information for a concept suggestion.

23898874.png

Configuration icon

Opens a dialogue to edit settings.

23898883.png

Spanner icon

Opens a dialogue to access repair functions.

Status icons

23898866.png

green

Indicates a valid state.

23898886.png

yellow

Indicates a medium state.

23898885.png

red

Indicates an invalid state.

Terminology Import Assistant icons - Results List

23898869.png

Check Mark icon

Indicates matching concepts. Additional edting is possible.

23898871.png

Add icon

Indicates non-matching concepts, where a missing concept can be added.

23898879.png

Question Mark icon

Indicates matches for terms in the imported list in a different language from the reference language.

23898872.png

Exclamation Mark icon

Indicates an inconsistency between data in the imported list and the thesaurus in regard to the reference language.