diff options
Diffstat (limited to 'Master/texmf-dist/doc/lualatex/ideavault/ideavault-doc.tex')
-rw-r--r-- | Master/texmf-dist/doc/lualatex/ideavault/ideavault-doc.tex | 30 |
1 files changed, 24 insertions, 6 deletions
diff --git a/Master/texmf-dist/doc/lualatex/ideavault/ideavault-doc.tex b/Master/texmf-dist/doc/lualatex/ideavault/ideavault-doc.tex index 0bea7622c68..5b2f2ff4a55 100644 --- a/Master/texmf-dist/doc/lualatex/ideavault/ideavault-doc.tex +++ b/Master/texmf-dist/doc/lualatex/ideavault/ideavault-doc.tex @@ -13,7 +13,8 @@ \par This is what the Idea Vault is used for. \section{Dependencies} -\par Idea Vault requires some packages (most of them for styling the printed idea). +\par Lua\LaTeX --- this is Lua\LaTeX package and will not work without Lua. +\par Additionally, Idea Vault requires some packages (most of them for styling the printed idea). \begin{itemize} \item \texttt{bookmark} \item \texttt{xargs} @@ -33,7 +34,7 @@ \subsection{\textbackslash{}createIdea} \begin{verbatim} -\printIdea[prefix]{name}{content}[dependencies][tags][weight] +\createIdea[prefix]{name}{content}[dependencies][tags][weight] \end{verbatim} \begin{itemize} \item \texttt{prefix}: prefix to locate the idea in. By default, equals to \texttt{default}. @@ -84,7 +85,7 @@ \par Example: \begin{verbatim} -\printIdeaAllWithPrefix[somePrefix][lcbf] +\printAllWithPrefix[somePrefix][lcbf] \end{verbatim} \subsection{\textbackslash{}printAllWithTag} @@ -100,7 +101,7 @@ \par Example: \begin{verbatim} -\printIdeaAllWithTag[somePrefix][lcbf]{tag1} +\printAllWithTag[somePrefix][lcbf]{tag1} \end{verbatim} \section{Style} @@ -109,15 +110,32 @@ \item \texttt{f}: Frame whole idea \item \texttt{c}: Center whole idea \item \texttt{b}: Create bookmark leading to the idea -\item \texttt{l}: Use large font for the name +\item \texttt{l}: Use Large font for the name +\item \texttt{L}: Use LARGE font for the name +\item \texttt{h}: Use huge font for the name +\item \texttt{H}: Use Huge font for the name \item \texttt{s}: Reserve some space using needspace to avoid awkward pagebreaks \item \texttt{e}: emph the name -\item \texttt{q}: do not print the name +\item \texttt{q}: Do not print the name \item \texttt{p}: New page before printing the idea (useful when doing serial printing, for example via \texttt{printAllWithTag}) \item \texttt{P}: New page after printing the idea (useful when doing serial printing, for example via \texttt{printAllWithTag}) \end{itemize} +\section{Debugging} +\par By default, this package avoids spamming too much to stdout, but sometimes it would be useful to see what idea creation/printing is triggering some problems. +\subsection{\textbackslash{}debugEnable} +\begin{verbatim} +\debugEnable +\end{verbatim} +\par Enables debug output --- remember, it may be quite overwhelming if there are a lot of ideas. +\subsection{\textbackslash{}debugDisable} +\begin{verbatim} +\debugDisable +\end{verbatim} +\par Disables debug output. Debug output is disabled by default, so it's only use is to revert the effect of enabling it. + \section{Example} +\par This is short example of code, and it's result. Extended example can be found in file \texttt{example.tex}. \subsection{Code} \begin{verbatim} \createIdea[somePrefix]{Not So Great Idea}{ |