search

fluid-project / infusion-docs

Documentation space for Infusion
http://docs.fluidproject.org/infusion
Creative Commons Attribution 4.0 International
8 stars 45 forks source link

Review use of inline table styles in complex doc tables #297

Open jobara opened 3 months ago

jobara commented 3 months ago

https://github.com/fluid-project/infusion-docs/pull/103 reintroduced some inline CSS styling that had previous been in use in the previous incarnation of our documentation on the Confluence wiki platform. Given we had had to manage without this for a while, the information that it conveyed (that particular sets of options were exclusive and not to be used simultaneously) had been encoded by other means (particular reference symbols such as daggers and double daggers). However, we should review the use of this styling and whether it is worth hoisting up into the shared infusion-docs.css area

Additional context or notes

Originally filed as FLUID-6063 by @amb26 on November 11, 2016.

jobara commented 3 months ago

Comment Migrated from FLUID-6063 originally posted by @sbates-idrc on November 18, 2016

An alternative to the use of styling and symbols such as daggers and double daggers for variant values would be to repeat each variation in full, such as in the jQuery docs: http://api.jquery.com/attr/#attr2 I think this might be a little easier to read but there is going to be some overhead in maintenance due to the duplication of information.