search

glossarist / iev-data

1 stars 1 forks source link

readme

= IEC IEV Termbase programs

== Purpose

This gem is used for parsing Excel exports from IEV.

The repository for the site is located at:

== Install

Add this line to your Gemfile:

[source,ruby]

gem 'iev-termbase'

And then execute:

[source,sh]

$ bundle

Or install it yourself as:

[source,sh]

$ gem install iev-termbase

== Usage

The gem comes with the following executable:

The IEV XLSX file needs to be obtained from the IEC administrator.

=== Using iev-termbase-xlsx2yaml

Run the following command:

[source,sh]

$ iev-termbase-xlsx2yaml [termbase.xlsx]

Where,

=== Structure of the IEV Excel export

The columns are:

IEVREF:: concept ID of this term LANGUAGE:: ISO 639-1 code (2 character) TERM:: the designation of this concept in language of LANGUAGE TERMATTRIBUTE:: a field of multiple uses, an array (separated by ;). More details below. SYNONYM1:: a synonym of this term SYNONYM1ATTRIBUTE:: the TERMATTRIBUTE that applies to SYNONYM1 SYNONYM1STATUS:: One of Preferred, Deprecated, nil. SYNONYM2:: second synonym of this term SYNONYM2ATTRIBUTE:: the TERMATTRIBUTE that applies to SYNONYM2 SYNONYM2STATUS:: One of Preferred, Deprecated, nil. SYNONYM3:: 3rd synonym of this term SYNONYM3ATTRIBUTE:: the TERMATTRIBUTE that applies to SYNONYM3 SYNONYM3STATUS:: One of Preferred, Deprecated, nil. SYMBOLE:: Math symbol DEFINITION:: definition text that includes <note> and <example> SOURCE:: which document was this term was taken from PUBLICATIONDATE:: YYYY-MM date of publication STATUS:: Only Standard for now REPLACES:: IEVREF for the deprecated term

==== Term field

==== Term attribute field

There are these data types inside the term attribute field. Make sure you split at ; for multiple entries.

f or m or n:: this means term.grammar-gender is one of them, term.plurality => singular n pl:: term.grammar-gender => n, term.plurality => plural m pl:: term.grammar-gender => m, term.plurality => plural f pl:: term.grammar-gender => f, term.plurality => plural pl:: term.plurality => plural (else, singular)

(in Zusammensetzungen) f:: term.compound-prefix => true, term.grammar-gender => f (in Zusammensetzungen) m:: term.compound-prefix => true, term.grammar-gender => m

m, (abgelehnt):: term.rejected => true, term.grammar-gender => m f, (abgelehnt):: term.rejected => true, term.grammar-gender => f

（略語）:: term.abbreviation => true

&lt;...&gt;:: this means the text (...) inside is the domain of this term (which field this term applies in)

&lt;相关条目：[SOMEIEVREF]&gt;:: SOMEIEVREF here represents the "related to" term. Add a relationship of this term to SOMEIEVREF.

Adjektiv, adj, 形容詞, 형용사:: sets term.grammar-particle to adj Präfix, (prefix), (préfixe), 接尾語, 접두사, （词头）:: sets term.affix to prefix

CA:: term.geographical_area => CA US:: term.geographical_area => US

noun, 名詞:: term.grammar-particle => noun (all terms default to noun) verb, 動詞:: term.grammar-particle => verb

(sigle international), m => term.acronym = true, term.international = true, term.gender = 'm'

==== Term definition field

We need to parse out all NOTEs and EXAMPLEs and normalize them.

For all This links to <a href=IEV112-01-01>quantity</a>, we parse them and replace with: This links to {{quantity, IEV:112-01-01}}.

e.g.

  1. Every <NOTE {N} - goes into a separate entry under notes::

[source]

quotient of two quantities of different dimensions, used as a multiplier to express the proportionality equation between them <NOTE 1 – A coefficient is a quantity having a dimension other than one. Examples: Hall coefficient, damping coefficient, temperature coefficient, gyromagnetic coefficient. <NOTE 2 – The term "modulus" is sometimes used instead of coefficient. Example: modulus of elasticity.

[source,yaml]

definition: quotient of two quantities of different dimensions, used as a multiplier to express the proportionality equation between them notes:

  1. A <NOTE - goes into notes::

[source]

quantity of dimension one defined by a combination of quantities <NOTE – Characteristic numbers occur in particular in the theory of similarity. They carry the word "number" in their names. Examples: Reynolds number, Prandtl number.

[source,yaml]

definition: notes:

  1. Sometimes there are many Note {N} to entry:, they are identical to NOTE -.

[source]

set of interrelated items that collectively fulfil a requirement

Note 1 to entry: A system is considered to have a defined real or abstract boundary.

Note 2 to entry: External resources (from outside the system boundary) may be required for the system to operate.

Note 3 to entry: A system structure may be hierarchical, e.g. system, subsystem, component, etc.

Note 4 to entry: Conditions of use and maintenance should be expressed or implied within the requirement. ---- [source,yaml] ---- definition: set of interrelated items that collectively fulfil a requirement notes: - A system is considered to have a defined real or abstract boundary. - External resources (from outside the system boundary) may be required for the system to operate. - A system structure may be hierarchical, e.g. system, subsystem, component, etc. - Conditions of use and maintenance should be expressed or implied within the requirement. ---- 4. Parse `EXAMPLE`: [source] ---- quantity which keeps the same value under particular circumstances, or which results from theoretical considerations

EXAMPLE time constant, equilibrium constant for a chemical reaction, fundamental physical constant. ---- => [source,yaml] ---- definition: {{quantity, IEV:112-01-01}} which keeps the same value under particular circumstances, or which results from theoretical considerations examples: - {{time constant, IEV:103-05-26}}, equilibrium constant for a chemical reaction, {{fundamental physical constant, IEV:112-03-09}}. ---- 5. Remember to parse both `EXAMPLE` and `Note {N} to entry:`. [source] ---- level of sub-division within a system hierarchy

EXAMPLE System, subsystem, assembly, and component.

Note 1 to entry: From the maintenance perspective, the indenture level depends upon various factors, including the complexity of the item's construction, the accessibility of sub items, skill level of maintenance personnel, test equipment facilities, and safety considerations. ---- [source,yaml] ---- definition: level of sub-division within a system hierarchy examples: - System, subsystem, assembly, and component. notes: - From the maintenance perspective, the indenture level depends upon various factors, including the complexity of the item's construction, the accessibility of sub items, skill level of maintenance personnel, test equipment facilities, and safety considerations. ---- 6. Remember to parse both `EXEMPLE` and `Note {N} à l’article:` in French [source] ---- niveau de subdivision à l’intérieur de la hiérarchie d’un système

EXEMPLE Système, sous-système, assemblage et composant.

Note 1 à l’article: Du point de vue de la maintenance, le niveau dans l’arborescence dépend de divers facteurs dont la complexité de la structure de l’entité, l’accessibilité aux sous-entités, le niveau de compétence du personnel de maintenance, les moyens de mesure et d’essai, et des considérations de sécurité. ---- [source,yaml] ---- definition: niveau de subdivision à l’intérieur de la hiérarchie d’un système examples: - Système, sous-système, assemblage et composant. notes: - Du point de vue de la maintenance, le niveau dans l’arborescence dépend de divers facteurs dont la complexité de la structure de l’entité, l’accessibilité aux sous-entités, le niveau de compétence du personnel de maintenance, les moyens de mesure et d’essai, et des considérations de sécurité. ---- ==== Source field Original: [source] ---- IEC 60050-311:2001, 311-01-04 ---- After parsing: [source,yaml] ---- authoritative_source: ref: IEC 60050-311:2001, 311-01-04 ---- == Credits This program is created and maintained by Ribose.