search

gs1 / EPCIS

Draft files being shared for EPCIS 2.0 development
Other
20 stars 7 forks source link

EPCIS Standard: JSON/JSON-LD expressed in Monospace? #158

Closed ghost closed 3 years ago

ghost commented 3 years ago

JSON/JSON-LD is not mentioned as something else that would appear in Monospace. Should it and should Monspace be used for the JSON/JSON-LD specific text in chapter 10? §4, pg33, ln401

mgh128 commented 3 years ago

JSON and JSON-LD are alternative data formats, just as XML is an existing data format used in EPCIS v1.2.

If I remember correctly, we don't see the abbreviation XML written in monospace type anywhere in EPCIS v1.2, so we probably don't need to write JSON or JSON-LD in monospace type either.

Monospace type is primarily used for blocks of code (e.g. event data examples) or the names of fieldnames, event types etc. that we define in EPCIS/CBV - not for every abbreviation.

ghost commented 3 years ago

I just double-checked the XML bindings chapter (9) and saw some snippets of XML code. I don't have a strong opinion about if we use Monospace or not. Just wanted to call it out for consistency.

It seems like snippets of JSON/JSON-LD are only embedded in tables but they should probably still be in Monospace for consistency if we are going to use it with XML snippets elsewhere.

mgh128 commented 3 years ago

I agree that code snippets (in XML, JSON/JSON-LD) should be in monospace font - and that we should have consistency, which might not yet be the case.

I may have misunderstood your question. The words XML, JSON/JSON-LD don't need monospace font, but code snippets do, though many of those are being moved to external artefact files.

ghost commented 3 years ago

Section 4 discusses Terminology and Typographical conventions. I was just noting that this section says Monospace type is to be used for snippets of code, UML, programming language, and XML identifiers. It specifically cites XML code should be in Monospace type while JSON/JSON-LD is not mentioned. Then when I looked through chapters 9 & 10, it appeared that we used Monospace type for XML snippets but did not for JSON/JSON-LD snippets. It felt like an inconsistent approach.

CraigRe commented 3 years ago

@mgh128 AND @visibleOrigins , fixed in section 10 of the EPCIS doc; will check the full EPCIS and CBV docs.