summaryrefslogtreecommitdiff
path: root/macros/latex/contrib/memory/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/latex/contrib/memory/README
Initial commit
Diffstat (limited to 'macros/latex/contrib/memory/README')
-rw-r--r--macros/latex/contrib/memory/README45
1 files changed, 45 insertions, 0 deletions
diff --git a/macros/latex/contrib/memory/README b/macros/latex/contrib/memory/README
new file mode 100644
index 0000000000..625922a8a0
--- /dev/null
+++ b/macros/latex/contrib/memory/README
@@ -0,0 +1,45 @@
+Copyright (C) 2013 by Song Zhiwei <songzw@gmail.com>
+
+The package memory.sty provides an easy way to declare object or array
+containers. If you are considering to use an auxiliary file, you really
+need this package rather than the heavy I/O manipulation.
+
+Usage:
+
+ 1. Declares a data variable in local scope or global scope.
+
+ \newdata{<local variable name>}
+ \newdata*{<global variable name>}
+
+ e.g. \newdata{Person} % Note: no backslash for variable declaration
+ \newdata*{Time} % Note: \Time is declared in global scope
+
+ 2. Uses = or := to set value. The := version sets expanded value to variable.
+
+ 1) Sets value as a single variable
+
+ \Person = {Song Zhiwei} % Note: add backslash for declared variable
+ \Time := \today % Note: set the expanded result of \today to \Time
+
+ 2) Sets value as an array.
+
+ \Person[1] = {28.3}
+
+ 3) Sets value as a multiple dimensional array.
+
+ \Time[2,5,\thesection] = \today % Note: the value will be saved globally
+ % for the global variable
+
+ 4) Sets value as an object.
+
+ \Person[description] = {A Chinese gentleman.}
+ \Person[hair] = {black}
+
+ 3. Gets values.
+
+ \Person % Song Zhiwei
+ \Time % May 13, 2013
+ \Person[1] % 28.3
+ \Time[2,5,\thesection] % May 13, 2013
+ \Person[description] % A Chinese gentleman.
+ \Person[hair] % black