summaryrefslogtreecommitdiff
path: root/Master/texmf-dist/doc
diff options
context:
space:
mode:
authorKarl Berry <karl@freefriends.org>2013-12-18 22:01:05 +0000
committerKarl Berry <karl@freefriends.org>2013-12-18 22:01:05 +0000
commit51dd85fd0039ad102b4c0551cefc94c2dc7b46c0 (patch)
treeaeffaffe79c01bdc75716dc1027215e5f00e8614 /Master/texmf-dist/doc
parentf1810cf69dfd54374426664fa922a3ddd7813df2 (diff)
dataref (18dec13)
git-svn-id: svn://tug.org/texlive/trunk@32438 c570f23f-e606-0410-a88d-b1316a301751
Diffstat (limited to 'Master/texmf-dist/doc')
-rw-r--r--Master/texmf-dist/doc/latex/dataref/README51
-rw-r--r--Master/texmf-dist/doc/latex/dataref/dataref.pdfbin0 -> 227149 bytes
2 files changed, 51 insertions, 0 deletions
diff --git a/Master/texmf-dist/doc/latex/dataref/README b/Master/texmf-dist/doc/latex/dataref/README
new file mode 100644
index 00000000000..7c2e73022d0
--- /dev/null
+++ b/Master/texmf-dist/doc/latex/dataref/README
@@ -0,0 +1,51 @@
+dataref
+=======
+
+Writing scientific texts is a craft. It is the craft of communicating your results to
+your colleagues and to the curious world public. Often your conclusions are based
+upon facts and numbers that you gathered during your research for the specific
+topic. You might have done many experiments and produced lot of data. The
+craft of writing is to guide your reader through a narrative that is based upon
+that data. But there may be many versions of that data. Perhaps you found a
+problem in your experiment, while already writing, that forces you back into the
+laboratory. After a while, the moon has done its circle many times, you return
+from that dark place and your methodology has improved as significantly as your
+data has. But now you have to rewrite that parts of the data, that reference the
+old data points.
+The dataref is here to help you with managing your data points. It provides
+you with macro style keys, that represent symbolic names for your datapints.
+You can reference those symbolic names with \dref, use them in calculations
+to have always up-to-date percentage values, define projections between sets of
+data points and document them. dataref also introduces the notion of assertions
+(\drefassert) for your results to ensure that your prosa text references fit the
+underlying data.
+
+Building the documentation
+==========================
+With latexmk installed:
+
+ make
+
+or
+
+ make dataref.sty; pdflatex dataref.dtx; pdflatex dataref.dtx; pdflatex dataref.dtx
+
+
+Examples
+========
+
+Setting symbolic data points
+
+ \drefset{/count}{42}
+ \drefset{/abc}{23}
+
+Referencing them with \dref, \drefcalc, \drefassert
+
+ \dref{/count} => 42
+ \drefcalc{data("/abc") / data("/count")} => 0.55
+ \drefassert{data("/abc") < data("/count")}
+
+Getting the latest version
+==========================
+
+dataref is hosted at github: https://github.com/stettberger/dataref \ No newline at end of file
diff --git a/Master/texmf-dist/doc/latex/dataref/dataref.pdf b/Master/texmf-dist/doc/latex/dataref/dataref.pdf
new file mode 100644
index 00000000000..a2f8d90b173
--- /dev/null
+++ b/Master/texmf-dist/doc/latex/dataref/dataref.pdf
Binary files differ