itsallcode / openfasttrace

Open source requirement tracing suite
GNU General Public License v3.0
100 stars 21 forks source link

Markdown table syntax not rendered #301

Open christophcemper opened 2 years ago

christophcemper commented 2 years ago

Is your feature request related to a problem? Please describe. We are using Markdown tables in our design spec, and they look ugly in the detail view.

Describe the solution you'd like The HTML output does not render them using a markdown processor, but seems to only pipe the source text into it.

We would love to have the Markdown actually rendered.

Describe alternatives you've considered We thought about using normal HTML table code in the Markdown source instead, but that's just a terrible idea I think

Additional context Additional problem we noticed is that the "underscore" we use in some identifies is being rendered wrongly compared to Hugo/Goldmark

RXN_SYS_DELAY_NETWORK_TIMEOUT

becomes

RXNSYSDELAYNETWORKTIMEOUT

image

Full source is this


## RXN_SYS_DELAY_NETWORK_TIMEOUT
`rxn~RXN_SYS_DELAY_NETWORK_TIMEOUT~1`

| Attribute         | Explanation                        |
| ----------------- | ---------------------------------- |
| ReactionID       | 2005                        |
| ReactionCode     | RXN_SYS_DELAY_NETWORK_TIMEOUT                        |
| ReactionSeverity | WARNING              |
| ReactionReason   | Network timeout after %1 ms. Reaction %2. %3 retries so far. |
| ReactionAction   | Investigate the limit and CFG. |
| ReactionAudience | Provider User |

ReactionData 
* %1 used timeout in milliseconds
* %2 which reaction RETRY | ERROR
* %3 number of retries that happened, MINUS this initial - so if no REtries happened, then 0

rendering fine here as

RXN_SYS_DELAY_NETWORK_TIMEOUT

rxn~RXN_SYS_DELAY_NETWORK_TIMEOUT~1

Attribute Explanation
ReactionID 2005
ReactionCode RXN_SYS_DELAY_NETWORK_TIMEOUT
ReactionSeverity WARNING
ReactionReason Network timeout after %1 ms. Reaction %2. %3 retries so far.
ReactionAction Investigate the limit and CFG.
ReactionAudience Provider User

ReactionData

redcatbear commented 1 year ago

Hi @christophcemper, I can see this as a useful add-on feature. Unfortunately at the moment we have a lot of other features with higher priority (as you probably already guessed since the ticket is from 2021). We are very sorry, but we don't have the capacity to start this any time soon.

One reason is that it was so far a conscious design decision to keep core OFT free of external dependencies (read libraries). The reasons being compactness and maintainability of the core. For implementing GitHub Flavored Markdown rendering in the HTML report I would either need an external library or implement the feature from scratch.