idaholab / raven

RAVEN is a flexible and multi-purpose probabilistic risk analysis, validation and uncertainty quantification, parameter optimization, model reduction and data knowledge-discovering framework.
https://raven.inl.gov/
Apache License 2.0
212 stars 131 forks source link

[TASK] add way to do subscripts in latex generated documentation #2291

Closed joshua-cogliati-inl closed 3 months ago

joshua-cogliati-inl commented 3 months ago

Issue Description

Is your feature request related to a problem? Please describe. Currently we escape underscores in the generateLatex function in InputData so that variable names like this_or_that don't cause latex errors. However, this can be a problem if we have $k_i$

Describe the solution you'd like Make the escaping underscores smarter. One possibility is to detect if we are in math mode. Another is to add a workaround to make things like k_{i} not escape (since a { will never be found in a variable name).

Describe alternatives you've considered Never use subscripts.


For Change Control Board: Issue Review

This review should occur before any development is performed as a response to this issue.


For Change Control Board: Issue Closure

This review should occur when the issue is imminently going to be closed.

wangcj05 commented 3 months ago

Issue closure checklist is good.