glossarist / glossarist/iev-data

IEV rendering rules

Open
#6 9 comments 0 reactions 0 assignees View on GitHub
Dominant language
Ruby
Stars
1
Forks
1
PR merge metrics
No merged PRs in 30d

Description

Rendering of Preferred and Deprecated synonyms (192-02-24, en)

>In the IEV the following are permitted according to today’s rules:
>- 2 preferred terms = rendered in bold (in the data Term and Synonym1)
>- admitted terms (in the data Synonym2 and Synonym3) = since a couple of years, rendered in lightface and Status=”Admitted”; before (and this is what you see in IEV 103 and 192), rendered in bold and Status = blank or “Preferred” – see for example 192-01-10 where the rendering of “LCC” and “CCV” according to today’s rules shall be in light face and not bold as was correct at the time that this standard was approved
>- deprecated terms = rendered in lightface with a prefix “DEPRECATED:” (Status = “Deprecated”) – see for example 192-01-11

Rendering of SOURCE (192-13-08)

> In standards and the IEV: prefix “SOURCE:”.
> In normal standards the source is delimited by square brackets; in the IEV there are no delimiters.

Rendering of numbered list items within definitions (192-13-03)
> This is an old entry – according to today’s rules it is not permissible since it contains 2 definitions. Can put 1) 2) or 1. 2.or 1st definition: 2nd definition.

Rendering of symbol in MathML (192-08-06, en)
> In the IEV, if a symbol is in the field “Symbol” and when rendered is placed between the IEV ref and the en language section, the symbol is “international”. See the snapshot for the rendering of this symbol in 192-08-06:

![image013](https://user-images.githubusercontent.com/11865/78649430-03d50e00-78f0-11ea-9be3-221863b1de8e.jpg)


> Rendering of symbol in image (192-08-06, fr)

Images, MathML, math in HTML, are all rendered the same way.

Math should be rendered the same way whichever language section it is in.

Ideally all math should be marked up in MathML.

Contributor guide

No contributing guide indexed for this repository

Research direction

Start by reviewing the examples 192-01-10, 192-01-11, 192-13-08, 192-13-03, and 192-08-06, along with the linked rendering snapshot. Compare preferred, admitted, deprecated, source, numbered-definition, symbol, image, and MathML cases against the stated rules. Done means each case renders consistently across the relevant language sections and formats.

Written by the indexing model from the issue text.

Assessment

Domain
documentation
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.