eu-digital-identity-wallet / eudi-doc-architecture-and-reference-framework

The European Digital Identity Wallet
https://eu-digital-identity-wallet.github.io/eudi-doc-architecture-and-reference-framework/
Other
369 stars 55 forks source link

Consider replacing tables by "definition lists" #189

Open toonn opened 2 weeks ago

toonn commented 2 weeks ago

Tables seem to be a pain point for ePub readers. One I tried drops them altogether, another renders them very poorly, cutting off any overflow over the pagebreak, making them almost equally unreadable unless the font size is decreased significantly.

While this is not the responsibility of the ARF, it might be worth considering using a more broadly compatible way of representing the same information.

The table in Section 9 References is a good example. It could be represented as a "definition list" as used in Section 4.2 Reference Architecture, which is a simple list separating the term being defined and the definition with simple formatting.

Excerpt of the table from Section 9 as a table and as a "definition list":

Item Reference Standard name/details
[2015/1505] COMMISSION IMPLEMENTING DECISION (EU) 2015/1505 of 8 September 2015 laying down technical specifications and formats relating to trusted lists pursuant to Article 22(5) of Regulation (EU) No 910/2014 of the European Parliament and of the Council on electronic identification and trust services for electronic transactions in the internal market.
[eIDAS 2.0] Regulation (EU) 2024/1183 of the European Parliament and of the Council of 11 April 2024 amending Regulation (EU) No 910/2014 as regards establishing the European Digital Identity Framework

The table header would probably better be dropped, potentially explained in a preceding paragraph if it contains significant information.

I do understand tables might provide valuable enough structure that replacing them altogether may be undesirable. In this case a Pandoc filter that only affects ePub output could be a compromise solution.