summaryrefslogtreecommitdiff
path: root/macros/luatex/latex/autopuncitems/autopuncitems.tex
diff options
context:
space:
mode:
Diffstat (limited to 'macros/luatex/latex/autopuncitems/autopuncitems.tex')
-rw-r--r--macros/luatex/latex/autopuncitems/autopuncitems.tex20
1 files changed, 16 insertions, 4 deletions
diff --git a/macros/luatex/latex/autopuncitems/autopuncitems.tex b/macros/luatex/latex/autopuncitems/autopuncitems.tex
index fd829b81e6..06f3f5e9be 100644
--- a/macros/luatex/latex/autopuncitems/autopuncitems.tex
+++ b/macros/luatex/latex/autopuncitems/autopuncitems.tex
@@ -1,6 +1,6 @@
% Kale Ewasiuk (kalekje@gmail.com)
-% 2021-12-20
-% Copyright (C) 2021 Kale Ewasiuk
+% 2022-01-18
+% Copyright (C) 2021-2022 Kale Ewasiuk
%
% Permission is hereby granted, free of charge, to any person obtaining a copy
% of this software and associated documentation files (the "Software"), to deal
@@ -62,12 +62,19 @@
\begin{document}
\maketitle
+{\Huge TODO make an environment that can be used outside of itemize, useful for beamer possibly}
+
\section{Introduction}
-This package provides the \cmd{autopunc} option in the
-\cmd{enumitem} environemnts \cmd{itemize}, \cmd{enumerate}, and \cmd{description}
+This package provides environments \cmd{AutoPuncItemize}, \cmd{AutoPuncItemizeO}, and \cmd{AutoPuncItemizeE} (beta)
to automatically punctuate the items.
+By default, it adds the \cmd{autopunc (O|E)} options in the
+\cmd{enumitem} environments \cmd{itemize}, \cmd{enumerate}, and \cmd{description}, to wrap the contents in these enviroments.
+If you want to skip this (say if you were using the beamer class which
+may be interefered with by enum item), pass the \cmd{noenumitem} option to this package. You can still use the environments with beamer, though.
It uses lua pattern matching to modify the environment's contents.
+
+
\section{Some commands}
\llcmd{\APomit}Used in an \cmd{\item} to signify that that item should not be automatically punctuated, and not be counted. Expands to nothing.\\
\llcmd{\APpass}Used in an \cmd{\item} to signify that that item should not be automatically punctuated, and but still counted. Expands to nothing.\\
@@ -84,6 +91,11 @@ It uses lua pattern matching to modify the environment's contents.
\end{addmargin}
+\section{Variants}
+\llcmd{autopunc}Does not expand the contents of environment. Tutorial on next section shows this.\\
+\llcmd{autopuncO}Expands the contents of environment once. Useful if \cmd{\item}'s are in a command \\
+\llcmd{autopuncE}Fully expands the contents of environment first. This is in-progress and should not be used.\\
+
\section{Tutorial}
\subsection{Basic Use}