Improve documentation - Githubissues

tweh / menukeys

A LaTeX package to typeset menu sequences, key strokes, paths etc.

47 stars 4 forks source link

Improve documentation #6

Open tweh opened 11 years ago

tweh commented 11 years ago

[x] spell checking
[x] section package options should become loading and options
- ~~[ ] load menukeys before babel — really necessary?~~
- ~~[ ] add a note on catoptions~~
[ ] better instructions on color changing (see menukeys/menukeys-farbe.zip)
[ ] add instructions on how to change the style of an existing menu macro
[ ] mention \strut as a helpful macro inside the user defined styles to make all boxes the same height.
[ ] add example how to change the style (\renewmenumacro) in section 4.2.4

DBX12 commented 2 years ago

I would suggest adding either a macro for a + or a note in the docs on how you get a literal plus in \keys{}. For anyone looking, it works with \keys{{+}}. Great library by the way :+1:

Skillmon commented 2 years ago

@DBX12 this is already documented, see page 4, subsection 4.1 "Basics":

The possible input separators are /, =, *, +, ,, ;, :, -, >, < and bslash (to use \ as separator). You can hide a separator from the parser by putting a part of the sequence in braces. Spaces around the separator will be ignored, i.e. \keys{\ctrl+C} equals \keys{\ctrl + C}.

Example \menu[,]{Extras,Settings,{Units, rulers and origin}} gives [Output]

DBX12 commented 2 years ago

Doh! Seems like I missed that when I skimmed the docs. Thanks for highlighting that part.

Skillmon commented 2 years ago

@DBX12 it happens. The real reason why documentation is written is only to say "documented" when questions arise :P