Jinwen-XU / create-theorem

Initializing and configuring theorem-like environments, with multilingual support
https://ctan.org/pkg/create-theorem
LaTeX Project Public License v1.3c
5 stars 0 forks source link

Highlight the necessity of a backend #7

Open dbitouze opened 1 year ago

dbitouze commented 1 year ago

When one reads the first section “How to load it” of the create‐theorem's documentation, what appears immediately is:

\usepackage[ ⟨options⟩ ]{create-theorem}

and I guess that most of the beginners in your package just add this line to their preamble and only when the compilation fails, they have a deeper look and read the sentence: “First, you need a backend to provide the command \newtheorem with the usual behaviour, for example, amsthm or ntheorem.”

Hence, I suggest to highlight the necessity of a backend with a first listing being:

\usepackage{amsthm}
% or \usepackage{ntheorem}
...
% near the end of the preamble
\usepackage[ ⟨options⟩ ]{create-theorem}
Jinwen-XU commented 1 year ago

Thank you also for this suggestion!

Well, this is just the side-effect of my intention to make the package options all on the first page ;)

I shall think of a better way to manage these texts when the next version releases. Frankly speaking my current focus is on rewriting crefthe so as to support German, and then create-theorem would be updated accordingly, but sadly this might take some time :(