gbif / doc-freshwater-data-publishing-guide

https://doi.org/10.35035/doc-sw3k-w725
Other
1 stars 0 forks source link

Square brackets vs. parentheses in tables #8

Closed kcopas closed 5 months ago

kcopas commented 8 months ago

in the column example we had further explanations in [] (square brackets): these are sometimes implemented in the table and sometimes replaced by ()

kcopas commented 8 months ago

Extensive use of square brackets in AsciiDoctor (the markup language used to format our documentation) is extremely problematic, as it relies on these characters for links. The intention is to replace brackets with parentheses. If any brackets remain, it simply means I've missed them.

jenlento commented 6 months ago

I think this is fine, particularly as the examples are shaded and the text that was in brackets is not shaded.

schmikloi commented 6 months ago

I agree, but checking this I saw that f. ex. "Adicella cremisa" in Table 4 "scientificName" is not shaded; I also found these non-shaded ones in other places. Is there any "rule" for the shades?

kcopas commented 6 months ago

@MattBlissett can you help me sort out what seems like an inconsistent display of code-formatted text both with and without shading?

I can't see any different in the source…

MattBlissett commented 5 months ago

There's a rule that code text format gets the background unless it's the only content in a table cell, but the rule defining what "only content" means is inadequate.

I've disabled it (see commit) for this document.