summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorHans Hagen <pragma@wxs.nl>2014-09-18 11:17:00 +0200
committerHans Hagen <pragma@wxs.nl>2014-09-18 11:17:00 +0200
commitea8cd771135d573fee6529e62e08468e79b12eab (patch)
treed2f7102bac47807fd3a0cbfeb02a0bb2f6f13a30 /doc
parent02d4d3cbde5e1e94e056cdf3b732145a37413fdb (diff)
downloadcontext-ea8cd771135d573fee6529e62e08468e79b12eab.tar.gz
beta 2014.09.18 11:17
Diffstat (limited to 'doc')
-rw-r--r--doc/context/manuals/allkind/mkiv-publications.pdfbin341600 -> 457944 bytes
-rw-r--r--doc/context/manuals/allkind/mkiv-publications.tex124
-rw-r--r--doc/context/scripts/mkiv/mtx-epub.html50
-rw-r--r--doc/context/scripts/mkiv/mtx-epub.man27
-rw-r--r--doc/context/scripts/mkiv/mtx-epub.xml23
5 files changed, 108 insertions, 116 deletions
diff --git a/doc/context/manuals/allkind/mkiv-publications.pdf b/doc/context/manuals/allkind/mkiv-publications.pdf
index 81b9537d9..b00659d04 100644
--- a/doc/context/manuals/allkind/mkiv-publications.pdf
+++ b/doc/context/manuals/allkind/mkiv-publications.pdf
Binary files differ
diff --git a/doc/context/manuals/allkind/mkiv-publications.tex b/doc/context/manuals/allkind/mkiv-publications.tex
index 837d531b5..3ea6d61a7 100644
--- a/doc/context/manuals/allkind/mkiv-publications.tex
+++ b/doc/context/manuals/allkind/mkiv-publications.tex
@@ -46,6 +46,8 @@
% todo: doi and url
+% do etallimit etaldisplay
+
\enablemode[export]
% criterium: all + sorttype=cite => citex before rest
@@ -55,6 +57,8 @@
% \enabletrackers[publications*]
+% \enabletrackers[publications.cite.match]
+
\dontcomplain
\setupbtxlistvariant [interaction=start]
@@ -76,6 +80,13 @@
\stopmode
+% todo: startdocument
+
+\setupinteraction
+ [title=BibTeX,
+ subtitle=The ConTeXt Way,
+ author=Hans Hagen]
+
\loadsetups[publications-en.xml] \enablemode[interface:setup:defaults]
% \input publ-tmp.mkiv
@@ -1443,6 +1454,80 @@ suffix, you can do this:
\usebtxdataset[standard][myformat::myfile.txt]
\stoptyping
+If you want to add information to an entry at runtime you can pass so called user
+variables with the \type {\cite} command. The following example demonstrates
+this. First we define a dataset:
+
+\startbuffer
+\startbuffer [knuth]
+@Book{knuth-texbook,
+ title = {The TeXbook},
+ author = {Knuth, Donald Ervin},
+ isbn = {0-201-13447-0},
+ series = {Computers {\&} Typesetting},
+ volume = {A},
+ year = {1986},
+ publisher = {Addison Wesley},
+ address = {Reading, MA},
+}
+\stopbuffer
+
+\definebtxdataset[knuth]
+\usebtxdataset [knuth] [knuth.buffer]
+\definebtxrendering[knuth][dataset=knuth]
+\stopbuffer
+
+\typebuffer \getbuffer
+
+\startbuffer[setup]
+\startsetups btx:apa:lefttext
+ \currentbtxlefttext
+ \btxspace
+ \btxdoifelseuservariable {notabene} {
+ {\bs \currentbtxuservariable{notabene}}
+ } {
+ % nothing
+ }
+ \btxspace
+\stopsetups
+\stopbuffer
+
+\getbuffer[setup]
+
+\startbuffer
+We all know the \TeX book by Don Knuth \citation [reference=knuth::knuth-texbook,
+lefttext={\bf >}] [notabene=Well known to \TEX\ users:].
+\stopbuffer
+
+We use this example where we use \type {\citation} instead of \type {\cite} because
+it is more tolerant with spaces. Because we pass user variables as second argument
+the first argument also has to be a key|/|value set.
+
+\typebuffer
+
+\blank \getbuffer \blank
+
+The list is typeset using:
+
+\startbuffer
+\placelistofpublications [knuth] [criterium=all]
+\stopbuffer
+
+\typebuffer
+
+and looks like this:
+
+\blank \getbuffer
+
+The injection of the user variables is up to you. Here we hooked it into an
+existing setup that we overload:
+
+\typebuffer[setup]
+
+The \type {lefttext} and \type {righttext} variables are also kept with the
+entry but these are checked for automatically. In this case it means that
+when no \type {lefttext} is specified, the \type {notabene} doesn't show up.
+
\stopchapter
\startchapter[title=Searching]
@@ -1612,6 +1697,9 @@ efficient.
The advantage of the more verbose ones is that you can use manipulators to
process them. This might come in handy when a database is inconsistent.
+The two parameters \type {etallimit} and \type {etaldisplay} control the
+maximum number of authors displayed ({\em these names can change}).
+
\stopchapter
\startchapter[title=Journals]
@@ -1727,19 +1815,19 @@ which shows the two entries pasted together:
As demonstration we also specified the separator although that one is already
set up by default.
-You can combine citations with additional text before and|/|or after it. This can
-be done per citation. This feature is of course not that useful, as one can
-put text before and after a citation anyway.
-
-\startbuffer
-foo bar \citation [before=<<,after=>>] [graph::Cleveland1993] foo bar
-\stopbuffer
-
-\typebuffer
-
-Gives:
-
-\blank \getbuffer \blank
+% You can combine citations with additional text before and|/|or after it. This can
+% be done per citation. This feature is of course not that useful, as one can
+% put text before and after a citation anyway.
+%
+% \startbuffer
+% foo bar \citation [before=<<,after=>>] [graph::Cleveland1993] foo bar
+% \stopbuffer
+%
+% \typebuffer
+%
+% Gives:
+%
+% \blank \getbuffer \blank
\stopchapter
@@ -1832,7 +1920,7 @@ categrories are rendered with a setup we can do the following:
\egroup
\stopsetups
-\placebtxrendering[duane]
+\placebtxrendering[duane][criterium=all]
\stopbuffer
\typebuffer \getbuffer
@@ -1995,16 +2083,20 @@ some benefits but also some drawbacks.
\startchapter[title=APA files]
-Here are the possible fields per category for APA:
+Here are the possible fields per category for APA: \footnote{Currently we show
+\type {publ-imp-test.bib} as we need to check things first.}
\definebtxdataset[apadef]
-\usebtxdataset[apadef][publ-imp-apa.bib]
+% \usebtxdataset[apadef][publ-imp-apa.bib]
+\usebtxdataset[apadef][\cldcontext{resolvers.findfile("publ-imp-test.bib")}]
\showbtxdatasetcompleteness[apadef]
\stopchapter
\stopbodymatter
+\writestatus{!!!!!!}{CHECK HYPHENS}
+
\stoptext
Todo:
diff --git a/doc/context/scripts/mkiv/mtx-epub.html b/doc/context/scripts/mkiv/mtx-epub.html
deleted file mode 100644
index 69d927b1d..000000000
--- a/doc/context/scripts/mkiv/mtx-epub.html
+++ /dev/null
@@ -1,50 +0,0 @@
-<?xml version="1.0" encoding="UTF-8"?>
-
-<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
-
-<!-- compare with lmx framework variant -->
-
-<!--
- filename : context-base.xml
- comment : companion to mtx-server-ctx-startup.tex
- author : Hans Hagen, PRAGMA-ADE, Hasselt NL
- copyright: PRAGMA ADE / ConTeXt Development Team
- license : see context related readme files
--->
-
-<html xmlns="http://www.w3.org/1999/xhtml" lang="en" xml:lang="en">
- <head>
- <title>ConTeXt EPUB Helpers 1.00</title>
- <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"/>
- <style type="text/css">
- body { color: #FFFFFF; background-color: #808080; font-family: optima, verdana, futura, "lucida sans", arial, geneva, helvetica, sans; font-size: 12px; line-height: 18px; } a:link, a:active, a:visited { color: #FFFFFF; } a.dir-view:link, a.dir-view:active, a.dir-view:visited { color: #FFFFFF; text-decoration: underline; } .valid { color: #00FF00; } .invalid { color: #FF0000; } button, .commonlink, .smallbutton { font-weight: bold; font-size: 12px; text-decoration: none; color: #000000; border-color: #7F7F7F; border-style: solid; border-width: .125ex; background-color: #FFFFFF; padding: .5ex; } .smallbutton { width: 1em; } a.commonlink:link, a.commonlink:active, a.commonlink:visited, a.smalllink:link, a.smalllink:active, a.smalllink:visited { font-weight: bold; font-size: 12px; text-decoration: none; color: #000000; } h1, .title { font-style: normal; font-weight: normal; font-size: 18px; line-height: 18px; margin-bottom: 20px; } h2, .subtitle { font-style: normal; font-weight: normal; font-size: 12px; margin-top: 18px; margin-bottom: 18px; } table { line-height: 18px; font-size: 12px; margin: 0; } th { font-weight: bold; text-align: left; padding-bottom: 6px; } .tc { font-weight: bold; text-align: left; } p, li { max-width: 60em; } .empty-line { margin-top: 4px; } .more-room { margin-right: 1.5em; } .much-more-room { margin-right: 3em; } #main { position: absolute; left: 10%; top: 10%; right: 10%; bottom: 10%; z-index: 2; width: 80%; height: 80%; padding: 0%; margin: 0%; overflow: auto; border-style: none; border-width: 0; background-color: #3F3F3F; } #main-settings { margin: 12px; x_max-width: 60em; line-height: 18px; font-size: 12px; } #left { position: absolute; top : 10%; left: 0%; bottom: 0%; right: 90%; z-index: 1; width: 10%; height: 90%; padding: 0%; margin: 0%; font-size: 16px; border-style: none; border-width: 0; background-color: #4F6F6F; } #right { position: absolute; top : 0%; left: 90%; bottom: 10%; right: 0%; z-index: 1; width: 10%; height: 90%; padding: 0%; margin: 0%; font-size: 16px; border-style: none; border-width: 0; background-color: #4F6F6F; _margin-left: -15px; } #bottom { position: absolute; left: 10%; right: 0%; top: 90%; bottom: 0%; z-index: 1; width: 90%; height: 10%; padding: 0%; margin: 0%; font-size: 16px; border-style: none; border-width: 0; background-color: #6F6F8F; } #top { position: absolute; left: 0%; right: 10%; top: 0%; bottom: 90%; z-index: 1; width: 90%; height: 10%; padding: 0%; margin: 0%; font-size: 16px; border-style: none; border-width: 0; background-color: #6F6F8F; } #top-one { position: absolute; bottom: 50%; width: 100%; buggedheight: 100%; } #top-two { position: relative; margin-bottom: -9px; margin-left: 12px; margin-right: 12px; line-height: 18px; text-align: right; vertical-align: middle; } #bottom-one { position: absolute; bottom: 50%; width: 100%; buggedheight: 100%; } #bottom-two { position: relative; margin-bottom: -9px; margin-left: 12px; margin-right: 12px; line-height: 18px; text-align: left; vertical-align: middle; } #left-one { position: absolute; width: 100%; buggedheight: 100%; } #left-two { position: relative; margin-top: 12px; line-height: 18px; text-align: center; vertical-align: top; } #right-one { display: table; height: 100%; width: 100%; } #right-two { display: table-row; height: 100%; width: 100%; } #right-three { display: table-cell; width: 100%; vertical-align: bottom; _position: absolute; _top: 100%; } #right-four { text-align: center; margin-bottom: 2ex; _position: relative; _top: -100%; } #more-top { position: absolute; top: 0%; left: 90%; bottom: 90%; right: 0%; z-index: 3; width: 10%; height: 10%; padding: 0%; margin: 0%; border-style: none; border-width: 0; } #more-top-settings { text-align: center; } #more-right-settings { margin-right: 12px; margin-left: 12px; line-height: 18px; font-size: 10px; text-align: center; } #right-safari { _display: table; width: 100%; height: 100%; }
- </style>
- <style type="text/css">
- </style>
- </head>
- <body>
- <div id="top"> <div id="top-one">
- <div id="top-two">ConTeXt EPUB Helpers 1.00 </div>
- </div>
- </div>
- <div id="bottom"> <div id="bottom-one">
- <div id="bottom-two">wiki: http://contextgarden.net | mail: ntg-context@ntg.nl | website: http://www.pragma-ade.nl</div>
- </div>
- </div>
- <div id="left"></div>
- <div id="right"></div>
- <div id="main">
- <div id='main-settings'>
- <h1>Command line options</h1>
-<table>
- <tr><th style="width: 10em">flag</th><th style="width: 8em">value</th><th>description</th></tr>
- <tr><th/><td/><td/></tr>
- <tr><th>--make</th><td></td><td>create epub zip file</td></tr>
- </table>
-<br/>
-<h1>Example</h1>
-<tt>mtxrun --script epub --make mydocument</tt>
-<br/><br/> </div>
- </div>
- </body>
- </html>
diff --git a/doc/context/scripts/mkiv/mtx-epub.man b/doc/context/scripts/mkiv/mtx-epub.man
deleted file mode 100644
index 4d42523fe..000000000
--- a/doc/context/scripts/mkiv/mtx-epub.man
+++ /dev/null
@@ -1,27 +0,0 @@
-.TH "mtx-epub" "1" "01-01-2014" "version 1.00" "ConTeXt EPUB Helpers"
-.SH NAME
-.B mtx-epub
-.SH SYNOPSIS
-.B mtxrun --script epub [
-.I OPTIONS ...
-.B ] [
-.I FILENAMES
-.B ]
-.SH DESCRIPTION
-.B ConTeXt EPUB Helpers
-.SH OPTIONS
-.TP
-.B --make
-create epub zip file
-.SH AUTHOR
-More information about ConTeXt and the tools that come with it can be found at:
-
-
-.B "maillist:"
-ntg-context@ntg.nl / http://www.ntg.nl/mailman/listinfo/ntg-context
-
-.B "webpage:"
-http://www.pragma-ade.nl / http://tex.aanhet.net
-
-.B "wiki:"
-http://contextgarden.net
diff --git a/doc/context/scripts/mkiv/mtx-epub.xml b/doc/context/scripts/mkiv/mtx-epub.xml
deleted file mode 100644
index 4a9160fbc..000000000
--- a/doc/context/scripts/mkiv/mtx-epub.xml
+++ /dev/null
@@ -1,23 +0,0 @@
-<?xml version="1.0"?>
-<application>
- <metadata>
- <entry name="name">mtx-epub</entry>
- <entry name="detail">ConTeXt EPUB Helpers</entry>
- <entry name="version">1.00</entry>
- </metadata>
- <flags>
- <category name="basic">
- <subcategory>
- <flag name="make"><short>create epub zip file</short></flag>
- </subcategory>
- </category>
- </flags>
- <examples>
- <category>
- <title>Example</title>
- <subcategory>
- <example><command>mtxrun --script epub --make mydocument</command></example>
- </subcategory>
- </category>
- </examples>
-</application>