summaryrefslogtreecommitdiff
path: root/macros/generic/gobble/README
diff options
context:
space:
mode:
authorNorbert Preining <norbert@preining.info>2019-09-02 13:46:59 +0900
committerNorbert Preining <norbert@preining.info>2019-09-02 13:46:59 +0900
commite0c6872cf40896c7be36b11dcc744620f10adf1d (patch)
tree60335e10d2f4354b0674ec22d7b53f0f8abee672 /macros/generic/gobble/README
Initial commit
Diffstat (limited to 'macros/generic/gobble/README')
-rw-r--r--macros/generic/gobble/README19
1 files changed, 19 insertions, 0 deletions
diff --git a/macros/generic/gobble/README b/macros/generic/gobble/README
new file mode 100644
index 0000000000..43249a5cb6
--- /dev/null
+++ b/macros/generic/gobble/README
@@ -0,0 +1,19 @@
+LaTeX and generic TeX packages 'gobble' and 'gobble-user'
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+Copyright (c) 2012-2019 by Martin Scharrer <martin@scharrer-online.de>
+CTAN: http://www.ctan.org/pkg/gobble
+Code repository: https://bitbucket.org/martin_scharrer/gobble
+
+The LaTeX package 'gobble' includes several gobble macros not
+included in the LaTeX kernel. These macros remove a number of
+arguments after them; a feature regulary used inside other
+macros. This includes gobble macros for optional arguments.
+
+The LaTeX package 'gobble-user' provides these macros to the
+user level, i.e. using names without '@', so that these can be
+used without \makeatletter and \makeatother.
+
+The same macros are provided inside .tex files for use with
+plain-TeX or other TeX formats. However, the gobble macros
+for optional macros require \@ifnextchar to be defined.
+