search

itc-wgtools / cPP-Tools

A repository for the creation of templates and guidance to be shared by all iTCs for the creation of cPPs and supporting documentation.
https://itc-wgtools.github.io/
6 stars 3 forks source link

Table rotated header instructions #76

Open woodbe opened 4 years ago

woodbe commented 4 years ago

I think I have figured out how to properly rotate the header row in table. I am still working on actually verifying the PDF output (which was the end goal for all this), but what I'm not sure about off hand is exactly how to provide these instruction.

The confusion here is because it requires more coordination between the people doing the editing and the people producing the output specifically.

While everything we have been doing before has largely been a case of separate people do their thing and the output is OK, here there needs to be coordination because there has to be an agreed-upon label (basically what the style name will be in the HTML output) and having entered that into the proper CSS file.

We have been using the default Asciidoctor style sheet to date, and a change needs to be made to have these rotated headers (not to mention, it may need to be tweaked on a per-document or even per-table basis, I'm not 100% sure).

One potential solution is for me to create an updated CSS template for the default Asciidoctor and include it in the itc_gentools GEM along with an update to call this specific style sheet. This would establish a basic set of requirements that wouldn't be so hard to edit in the future (and the templates could be modified to have the style included in the tables where it would be needed).

Another solution would be to lay out the requirements and let the iTC figure it out, but that isn't as ideal.

Part of the question is where should some of these things go. I can see some of it maybe going in the itc_gentools docs (like how to use/edit the style) and maybe adding an option for the stylesheet as one of the command line arguments (i.e. use the default or create your own).

If you read this post you can see my description of how this would work (focused on us) in relation to a question from someone else.

Please let me know what you think about where and how to place these instructions.

woodbe commented 4 years ago

Based on call discussion, place into the docs as normal with a wiki page similar to the forum post for more details. Maybe this should be in the contributing doc.

woodbe commented 4 years ago

I starting to look into the output program from this and am running into problems getting it to work with all the pieces (things like the image output from text that we are using). I see more tools that may make it work, and I've been communicating about a few things with the maintainers of the project, but right now, I don't see this as being something that will be usable in the short term

woodbe commented 4 years ago

In the meantime, I see two ways to handle this. The first is what I have seen in some PPs (like NDcPP), where they don't have the tables with the coverage, so this isn't even needed. In the ones where the iTC chooses to do this, I would likely create shortnames for each of the SPD so they could be used in the table without rotating. Then I may build several tables (breaking out into smaller groups on the horizontal).