Showcase Macros

The qdocconf files provided by this qdoc-style also provide some macros.

\shortcut & \key

\shortcut{\key{some-key}} will display some text as a shortcut some-key.

For example \shortcut{\key{Ctrl}+\key{Shift}+\key{C}} is displayed as Ctrl+Shift+C

\math & \mathline

You can use math formular, like \math{42\cdot x^3 + \frac{\sqrt{t}}{2^n}} for a result like \(42\cdot x^3 + \frac{\sqrt{t}}{2^n}\)

\mark

Mark some text,as if it was marked with a textmarker.

\s

Draw some text as striked through.

\del

Draw some text as deleted. The difference to \s is, that one css style might tint deleted text red while a simple stroke though text will not changing the color of the text.

\ins

Draw some text as inserted. The difference to smiply underlined text is, that one css style might tint inserted text green while a simple underlined though text will not changing the color of the text.

\abbr

Abbreviations are also easy to handle. so the user can known the difference between a KNN and a KNN

\space

\space just outputs a single whitespace character. Usecase:

Without \c\space
\snippet showcase/cpp/snippetexample1.cpp Snippet A
\snippet showcase/cpp/snippetexample2.cpp Snippet B

With \c\space
\snippet showcase/cpp/snippetexample1.cpp Snippet A
\space
\snippet showcase/cpp/snippetexample2.cpp Snippet B

will produce

Without \space

void snippetA()
{
  // do something
}
void snippetB()
{
  // do something
}

With \space

void snippetA()
{
  // do something
}

void snippetB()
{
  // do something
}