Skip to content

Create some table samples for preliminary review by ISO editors #1255

@RexJaeschke

Description

@RexJaeschke

@bobmartin3, @ramartin [FYI, the second tag works, but the first does not]

I've labeled this both "ISO conformance" and "ISO publication" as it's not yet decided whether we'll deal with this in advance of submission or only in reaction to push back between balloting and publication.

The first (large) block of text has to do with tables actually represented as such, while the second briefly mentions those rendered as figures. Both need to be considered here.

ISO has detailed rules about the format of tables (ISO Directives). In summary:

  • Tables need captions
  • Tables need to be numbered
  • Each table must be referenced in the text
  • Column headings need to be bold
  • While I don't see a rule, all table examples in the ISO Directives have centered column headings while some of ours do not, so best to center all of them.

Looking at the Word/PDF rendering, tables are used a great deal, and if I understand correctly, they are mostly generated programmatically. I'm looking at those in Clause 6, "Core," specifically.

Clearly, adding to each table a caption with number and a reference to that table is a lot of work, that can not obviously be done in md especially when a later insertion or removal of a table will alter the numbering (and references to them). As such, on a group call some weeks ago, Rex took the following action item:

Rex will send a representative sample to an ISO editor to see if the current format is acceptable. If possible, we want to avoid having to do a lot of work here.

Some weeks ago, it was suggested to me that we might not use the generated Word spec for the ISO submission, instead using pandoc to convert the md to Word. What is the current thinking re that?

What we send to ISO for their preliminary evaluation may well depend on the answer to my previous questions.

Using the existing Word/PDF, I can take some jpeg snapshots and send those.

How should we proceed?

Separately, each Metadata section appears to contain a table, but one that is imported as a figure rather than being a Word table. As ISO has similar requirements for figures tables (ISO Directives), we really wouldn't want to have to provide captions, numbering, and references to all of these. So I propose we include samples of these as well.

Metadata

Metadata

Assignees

No one assigned

    Labels

    ISO conformanceChanges needed to conform to ISO guidelinesISO publicationLast minute publication (considerations for markdown to word)

    Type

    No type

    Projects

    No projects

    Milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions