Product Use Case Table Number in GlassBR SRS

[samm82]

This table is called "Table 2", despite being the first table in the document. It should be updated to "Table 1" to match caseStudies and be correct.

The rest of the tables then need to be shifted ie. the following should be tables 2 and 3:

[smiths]

Yes, please update the generated tex so that the table number is correct. However, I have a feeling that this might be challenging. It doesn't happen often, but I vaguely recall running into issues like this in the past. It may be a weird interaction between LaTeX packages. It might not be easy to diagnose the problem and come up with a fix.

[samm82]

The correct table number is shown when the Table of Symbols (the only longtabu before the Product Use Table; the Tables of Units and Abbreviations/Acronyms use longtable*) is removed. I think this is because there isn't a caption specified for the Table of Symbols, but the figure number is still "1", so the next longtabu (the Product Use Table) gets incremented to "2".

[JacquesCarette]

Any recommendation on how to fix this?

[samm82]

We could make every table referable (ie. give them captions with their numbers), although this could have formatting issues for the LaTeX. This would also allow us to reference these tables directly in the future.

[JacquesCarette]

I think that yes, all tables should be referable. We should label all tables, but may indeed choose to have an empty caption (which should help with the formatting).

[samm82]

An update: out of the three tables that appear before this "Table 2" (Table of Units, Table of Symbols, and Abbreviations and Acronyms), "Table 1" is the only one that uses \begin{longtabu} (Table of Symbols); the other two use \begin{longtable*}. This prevents them from having figure numbers and throws an error if a caption is added to it. Labeling these tables seems redundant, since they are the only thing in their section, and the section title labels the table quite nicely, but I think the easiest and most consistent fix would be to add a caption to every table, which will include changing \begin{longtable*} to \begin{longtable}.

Thoughts? EDIT: Once I fix this, should I make a low priority issue to add an option for foregoing the caption? I think this will be a little difficult, since you can't prevent longtabu from incrementing the table count - it has to be done manually.

[smiths]

@samm82, your recommendation seems to match with the comment from @JacquesCarette from last summer. You can create a table with a caption, and set the caption to an empty string.

[samm82]

I interpreted Dr. Carette's comment to have an "empty caption" to mean that there shouldn't be anything under the table, but I think an "empty caption" as in no description is straightforward enough. My one suspicion is that an empty string will cause "Table #:" to be displayed under the table, and the colon would be unwanted, but I'll check it out tomorrow.

[smiths]

@samm82, you have a good point about the Table number. I think what we are talking about is the same interface in Drasil, but having an empty caption in Drasil. I'm sure @JacquesCarette will let us know what he is thinking. 😄

[samm82]

The behaviour is changed so that every table is numbered (and labelled ie. "Table 1" in LaTeX) and the caption can be toggled ("Table 1" vs. "Table 1: Table of Units"). Will be closed with merge of #1250.

[JacquesCarette]

My opinion: good work @samm82 !