Show tree structure on index.html

[jacebrowning]

TODO:

• Add a traceability matrix to index.html
• Sort sibling documents by prefix (for a consent column order)
• Add Tree method to display the tree as text
• Add a similar structure to generated index.html
• Handle unknown items in the traceability table

[jacebrowning]

For example, http://jacebrowning.github.io/doorstop-demo could look like:

SYS
|   
+ - HLR
    |
    + - LLR
    |   |
    |   + - LLT
    |
    + - HLT

[jkloo]

do you want just the layout like above, or the entire tree (show all items and links)?

[jacebrowning]

@jkloo initially, just the links to documents. What you're describing could come later...

[jacebrowning]

I have also considered generating a traceablity table as the index:

SYS	HLR	HLT	LLR	LLT
SYS1	HLR1
SYS1	HLR2
	HLR1	HLT1

Or both?

[theovoss]

A table would get huge, and at that point it would be hard to determine any meaningful information from it.
I guess you'd have the same issue with the tree structure (unless it's collapsible).
On the other hand, I know that some people would still want the table.

[robertberrington]

A traceability table is a deliverable to some customers.

I'd like to see a command line function like:

doorstop link [ID] --show-traceability
INFO: parent link(s) = REQ123 -> SYS123
INFO: child link(s) = SYS123 -> [ [SWHLR456 -> SWLLR789], [HWHLR321 -> [HWLLR654, HWLLR987] ] ]

[jacebrowning]

@robertberrington that should be pretty easy to add. I'm going to think about other verbs to use so as not to overload the link command unless I have to (same applies for #25).

[theovoss]

@jacebrowning that sounds like a different export format to me.

[jacebrowning]

@theovoss @robertberrington I'm moving this portion (traceability reporting) of the discussion over to #100. I think it still makes sense to have a table of links on index.html (that can optionally be disabled).