summaryrefslogtreecommitdiff
path: root/macros/latex/contrib/onedown/README
blob: e4e096028ca4dc5f989c56471f69cf5a7c5f4ac5 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
--------------------------------------------------------------------------
The OneDown package v1.4 - 2019/10/15
A package to typeset diagrams for the game of bridge

--------------------------------------------------------------------------
Jacob Wiersma
Web:   
E-Mail: jack@schuli-wirsi.de
--------------------------------------------------------------------------
Copyright 2018 Jacob Wiersma

This work has the LPPL maintenance status `maintained'.

The Current Maintainer of this work is Jacob Wiersma.
--------------------------------------------------------------------------
LICENCE
This work may be distributed and/or modified under the
conditions of the LaTeX Project Public License, either version 1.3
of this license or (at your option) any later version.
The latest version of this license is in
  http://www.latex-project.org/lppl.txt
and version 1.3 or later is part of all distributions of LaTeX
version 2005/12/01 or later.

--------------------------------------------------------------------------
The OneDown package consists of

the files
 - README  (this file)
   onedown.dtx, onedown.ins,
   onedown.sty, onedown.pdf

 - ODw-danish.trsl ODw-english.trsl ODw-french.trsl
   ODw-norwegian.trsl ODw-turkish.trsl ODw-dutch.trsl
   ODw-fallback.trsl ODw-german.trsl ODw-swedish.trsl
   ODw-spanish.trsl

the directory examples with the files  
 - onedown-examples.pdf onedown-ref.pdf
   and 21 *.tex files
--------------------------------------------------------------------------
INSTALLATION
If onedown.sty is missing or you got a newer onedown.dtx/onedown.ins:
1)  Run LaTeX on onedown.ins to create a new onedown.sty
2)  Copy onedown.sty and the .trsl files in your latex path

--------------------------------------------------------------------------
DOCUMENTATION
Available in onedown.pdf. This file may be created from onedown.dtx by
running: pdflatex --shell-escape onedown.dtx

In order to get the labels, indexes etc. you must run:
pdflatex --shell-escape onedown.dtx 
makeindex -s gind.ist onedown.idx 
makeindex -s gglo.ist -o onedown.gls onedown.glo 
pdflatex --shell-escape onedown.dtx 
pdflatex --shell-escape onedown.dtx

If you want a printable version without colors (for a monochrome printer),
your last command should be:

pdflatex --shell-escape '\AtBeginDocument{\NoColortrue}\input{onedown.dtx}'

The option --shell-escape is necessary to build the list of user commands
that are written in a separate file. Without this option this list will not
be generated. Use this option at your own risk.

MORE DOCUMENTATION
- examples/onedown-examples.pdf
- examples/onedown-ref.pdf
These are in english. To get PDFs which shows the (output of) onedown commands
in your language run
	pdflatex  '\AtBeginDocument{\def\RefLang{french}}\input{onedown-ref.tex}'
or
  pdflatex '\AtBeginDocument{\def\ExLang{norsk}}\input{onedown-examples.tex}'

This works for all supported languages
--------------------------------------------------------------------------
DESCRIPTION
This packages provides macros to typeset bridge diagrams, including hands
(stand alone or around a compass), bidding tables (stand alone or in
connection with hands/compass), trick tables and expert quizes.
--------------------------------------------------------------------------
REQUIREMENTS
Allthough the package uses other packages, they are in every recent LaTeX
distribution and will be loaded automatically. In other words: you don't
need to install other packages.
--------------------------------------------------------------------------
If you have any ideas, questions, suggestions or bugs to report, please
feel free to contact me.
--------------------------------------------------------------------------
DISCLAIMER
This bundle is provided 'as is' without any warranty.

Jacob Wiersma