I end up reading a lot of LaTeX manuals but often it's because I only
need to get a basic idea of its usage. Too many times you end up
having to read pages and pages just to figure out the proper syntax
for \usepackage and I've seen manuals that never even mention it. What
I really like is when a manual has a quick-start guide. I would love
to see this become standard practice for packages.
So here's my idea, right after the title page and before the table of
contents you could have a Quick Start page that would have an MWE,
something like:
\documentclass{article} % Should work with all major classes
\usepackage{fontspec} % Lilyglyphs only works with XeLaTeX or LuaLaTeX
\usepackage{lilyglyphs} % There are no options to pass to the package
\begin{document}
\lilyTimeC \flat \twoBeamedQuavers \crotchetRest % Puts a space
between each glyph
\lilyTimeC* \flat* \twoBeamedQuavers* \crotchetRest* % No space
between each glyph
% See rest of manual for more ways to specify glyphs and other features.
\end{document}
and then a printout of the resulting pdf. You might choose examples
that show a better range but this the is basic idea.
uliska
commented
11 years ago
Reported by David Bellows:
Hey Urs,
I end up reading a lot of LaTeX manuals but often it's because I only need to get a basic idea of its usage. Too many times you end up having to read pages and pages just to figure out the proper syntax for \usepackage and I've seen manuals that never even mention it. What I really like is when a manual has a quick-start guide. I would love to see this become standard practice for packages.
So here's my idea, right after the title page and before the table of contents you could have a Quick Start page that would have an MWE, something like:
and then a printout of the resulting pdf. You might choose examples that show a better range but this the is basic idea.