Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

documentation: example with thmbox={<kv-list>} #35

Open
mbertucci47 opened this issue Feb 18, 2023 · 1 comment
Open

documentation: example with thmbox={<kv-list>} #35

mbertucci47 opened this issue Feb 18, 2023 · 1 comment
Labels
documentation Improvements or additions to documentation upstream:thmbox

Comments

@mbertucci47
Copy link
Collaborator

mbertucci47 commented Feb 18, 2023

Since theorems declared with the thmbox key do not respect most (all?) options from a style declared with \declaretheoremstyle, it would be useful to have an example in the documentation that uses the fact that the value of thmbox= can be a list of thmbox keys, similar to what is already done for shadethm. For example, something like

\declaretheorem[thmbox={L,bodystyle=\normalfont\noindent,leftmargin=1cm}]{boxtheorem}

There is the issue of needing four # in the parameters of headstyle and titlestyle mentioned in #25, but this could also be documented or an alternative approach given using \thmboxoptions:

\declaretheorem[thmbox={L,bodystyle=\normalfont\noindent,leftmargin=1cm}]{boxtheorem}
\thmboxoptions{headstyle={\textsc{#1 #2}}}

Note that \thmboxoptions must be used after since thmbox is not loaded prior to using the thmbox key.

It could be argued that users should just move to using mdframed or tcolorbox for fancy theorems, but I think thmbox gives a nice lightweight alternative that doesn't need to be abandoned quite yet.

@muzimuzhi muzimuzhi added documentation Improvements or additions to documentation upstream:thmbox labels Feb 19, 2023
@muzimuzhi
Copy link
Owner

muzimuzhi commented Feb 19, 2023

It could be argued that users should just move to using mdframed or tcolorbox for fancy theorems, but I think thmbox gives a nice lightweight alternative that doesn't need to be abandoned quite yet.

+1 You've said the best I can argue :D

Will add an example following your suggesttion, and maybe partially solve #25 as well.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation upstream:thmbox
Projects
None yet
Development

No branches or pull requests

2 participants