summaryrefslogtreecommitdiff
path: root/Master/texmf-dist/doc/latex/romanbar
diff options
context:
space:
mode:
authorKarl Berry <karl@freefriends.org>2012-01-03 00:14:41 +0000
committerKarl Berry <karl@freefriends.org>2012-01-03 00:14:41 +0000
commit20d68fe66aecde758e45ff238550f92ecff39cac (patch)
tree5f116721982e6a038384fad96df77d337b05b9b8 /Master/texmf-dist/doc/latex/romanbar
parent27a5cc0e9cbd1ea3a4f4d2f57e3d228ddf8d2ac7 (diff)
romanbar (2jan12)
git-svn-id: svn://tug.org/texlive/trunk@25005 c570f23f-e606-0410-a88d-b1316a301751
Diffstat (limited to 'Master/texmf-dist/doc/latex/romanbar')
-rw-r--r--Master/texmf-dist/doc/latex/romanbar/README164
-rw-r--r--Master/texmf-dist/doc/latex/romanbar/romanbar-example.pdfbin0 -> 70611 bytes
-rw-r--r--Master/texmf-dist/doc/latex/romanbar/romanbar-example.tex119
-rw-r--r--Master/texmf-dist/doc/latex/romanbar/romanbar.pdfbin0 -> 289679 bytes
4 files changed, 283 insertions, 0 deletions
diff --git a/Master/texmf-dist/doc/latex/romanbar/README b/Master/texmf-dist/doc/latex/romanbar/README
new file mode 100644
index 00000000000..2309ad74b2f
--- /dev/null
+++ b/Master/texmf-dist/doc/latex/romanbar/README
@@ -0,0 +1,164 @@
+README for romanbar package, 2012/01/01, v1.0f
+
+
+TABLE OF CONTENTS
+=================
+
+1 Introduction
+2 Download
+3 Installation
+4 Additional Packages
+5 Package Compatibility
+6 Authors/Maintainer
+7 Bug Reports
+8 Known Problems
+
+
+1 INTRODUCTION
+==============
+
+This LaTeX package allows to write Roman numbers (or any
+other text) with bars. (Additionally, commands for converting
+Arabic numbers into Roman ones are provided and
+an \ifnumeric test function.)
+The original code for the bars was written by
+Prof. Enrico Gregorio (egreg) and published at
+http://tex.stackexchange.com/questions/24065/
+roman-numerals-formatting/24084#24084
+This material is subject to the LaTeX Project Public License
+(LPPL). See http://www.ctan.org/tex-archive/help/Catalogue/
+licenses.lppl.html for the details of that license.
+
+
+2 DOWNLOAD
+==========
+
+`romanbar' should become available on CTAN soon:
+ CTAN:macros/latex/contrib/romanbar/
+
+Running
+tex romanbar.dtx
+generates the files
+romanbar.ins, romanbar.drv, romanbar.sty,
+and romanbar-example.tex.
+
+Also a ZIP file is provided that contains these files,
+the manual (romanbar.pdf), the compiled example
+(romanbar-example.pdf), and this README, already
+sorted in a TDS tree (to be available soon):
+ CTAN:install/macros/latex/contrib/romanbar.tds.zip
+
+`CTAN:' means one of the `Comprehensive TeX Archive Network'
+nodes or one of its mirrors. This is explained in
+ http://www.tex.ac.uk/cgi-bin/texfaq2html?label=archives
+
+The CTAN stuff will be mirrored automatically from the
+ftp server, so
+ ftp://ftp.tug.org/pub/tex/romanbar/
+corresponds to
+ CTAN:macros/latex/contrib/romanbar/
+
+
+3 INSTALLATION
+==============
+
+Installation with ZIP file in TDS format
+----------------------------------------
+The ZIP file `romanbar.tds.zip' contains the files
+sorted in a TDS tree. Thus you can directly unpack the
+ZIP file inside a TDS tree.
+(See CTAN:tds.zip for an explanation of TDS.)
+Example:
+ cd /...somewhere.../texmf
+ unzip /...downloadpath.../romanbar.tds.zip
+Do not forget to refresh the file name database of this
+TDS tree.
+Example:
+ texhash /...somewhere.../texmf
+
+Manual installation
+-------------------
+a) Download the romanbar files from CTAN.
+ If necessary, unpack them.
+b) Generate the package and driver files:
+ tex romanbar.dtx
+c) Install the file `*.sty' in your TDS tree:
+ cp *.sty TDS:tex/latex/romanbar/
+ Replace `TDS:' by the prefix of your TDS tree
+ (texmf directory).
+d) Create the documentation (if necessary), e.g.
+ pdflatex romanbar.dtx
+ makeindex -s gind.ist romanbar.idx
+ pdflatex romanbar.dtx
+ makeindex -s gind.ist romanbar.idx
+ pdflatex romanbar.dtx
+e) Update the databases if necessary, e.g. for teTeX:
+ mktexlsr .../texmf
+f) Create the romanbar-example.pdf (if necessary), e.g.
+ pdflatex romanbar-example.tex
+g) Copy the documentation files to
+ "TDS:doc/latex/romanbar/":
+ README, romanbar.pdf, romanbar-example.tex,
+ romanbar-example.pdf.
+
+
+4 ADDITIONAL PACKAGES
+=====================
+
+romanbar itself does not load other packages.
+The romanbar-example.tex uses
+* hyperref: http://ctan.org/pkg/hyperref
+which again loads other packages
+(see the result of the \listfiles command in the log-file
+ of the example).
+
+
+5 PACKAGE COMPATIBILITY
+=======================
+
+There are no known incompatibilities.
+
+
+6 AUTHOR/MAINTAINER
+=====================
+
+* Author of the original code for the bars:
+ Prof. Enrico Gregorio (egreg), see
+ http://tex.stackexchange.com/questions/24065/
+ roman-numerals-formatting/24084#24084
+* Author of the recent package and current maintainer:
+ H.-Martin Münch
+
+
+7 BUG REPORTS
+==============
+
+A bug report should contain:
+* Comprehensive problem description. This includes error or
+ warning messages.
+* \errorcontextlines=\maxdimen can be added in the
+ TeX code to get more information in TeX error messages.
+* Minimal test file that shows the problem, but does not
+ contain any unnecessary packages and code.
+* Used drivers/programs.
+* Version information about used packages and programs.
+* If you are using LaTeX, then add "\listfiles". Then
+ a list of version information is printed at the end
+ of the LaTeX run.
+* Please no other files than the minimal test file.
+ The other files .log, .dvi, .ps, .pdf are seldom
+ necessary, so send them only on request.
+* Please .zip or .tar.gz your file(s) before sending them!
+
+Bug address
+-----------
+Bug reports can be send to the maintainer:
+ H.-Martin Münch
+ <Martin [dot] Muench [at] Uni-Bonn [dot] de>
+
+
+8 KNOWN PROBLEMS
+=================
+
+Depending on used pdf-viewer and zoom level
+the bars might not look as good as when printed. \ No newline at end of file
diff --git a/Master/texmf-dist/doc/latex/romanbar/romanbar-example.pdf b/Master/texmf-dist/doc/latex/romanbar/romanbar-example.pdf
new file mode 100644
index 00000000000..361c3c412db
--- /dev/null
+++ b/Master/texmf-dist/doc/latex/romanbar/romanbar-example.pdf
Binary files differ
diff --git a/Master/texmf-dist/doc/latex/romanbar/romanbar-example.tex b/Master/texmf-dist/doc/latex/romanbar/romanbar-example.tex
new file mode 100644
index 00000000000..33391bd8afa
--- /dev/null
+++ b/Master/texmf-dist/doc/latex/romanbar/romanbar-example.tex
@@ -0,0 +1,119 @@
+%%
+%% This is file `romanbar-example.tex',
+%% generated with the docstrip utility.
+%%
+%% The original source files were:
+%%
+%% romanbar.dtx (with options: `example')
+%%
+%% This is a generated file.
+%%
+%% Project: romanbar
+%% Version: 2012/01/01 v1.0f
+%%
+%% Copyright (C) 2011 by
+%% H.-Martin M"unch <Martin dot Muench at Uni-Bonn dot de>
+%%
+%% The usual disclaimer applies:
+%% If it doesn't work right that's your problem.
+%% (Nevertheless, send an e-mail to the maintainer
+%% when you find an error in this package.)
+%%
+%% This work may be distributed and/or modified under the
+%% conditions of the LaTeX Project Public License, either
+%% version 1.3c of this license or (at your option) any later
+%% version. This version of this license is in
+%% http://www.latex-project.org/lppl/lppl-1-3c.txt
+%% and the latest version of this license is in
+%% http://www.latex-project.org/lppl.txt
+%% and version 1.3c or later is part of all distributions of
+%% LaTeX version 2005/12/01 or later.
+%%
+%% This work has the LPPL maintenance status "maintained".
+%%
+%% The Current Maintainer of this work is H.-Martin Muench.
+%%
+%% This work consists of the main source file romanbar.dtx,
+%% the README, and the derived files
+%% romanbar.sty, romanbar.pdf,
+%% romanbar.ins, romanbar.drv,
+%% romanbar-example.tex, romanbar-example.pdf.
+%%
+\documentclass[british]{article}[2007/10/19]% v1.4h
+%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
+\usepackage[extension=pdf,%
+ plainpages=false,%
+ pdfpagelabels=true,%
+ hyperindex=false,%
+ pdflang={en},%
+ pdftitle={romanbar package example},%
+ pdfauthor={H.-Martin Muench},%
+ pdfsubject={Example for the romanbar package},%
+ pdfkeywords={LaTeX, romanbar, roman, Roman, bars, H.-Martin Muench},%
+ pdfview={XYZ null null 1},%
+ pdfstartview={XYZ null null 1},%
+ pdfpagelayout=SinglePage]{hyperref}[2011/12/04]% v6.82m
+\usepackage{romanbar}[2012/01/01]% v1.0f
+\gdef\unit#1{\mathord{\thinspace\mathrm{#1}}}%
+\listfiles
+\begin{document}
+\pagenumbering{arabic}
+\section*{Example for romanbar}
+
+This example demonstrates the use of package\newline
+\textsf{romanbar}, v1.0f as of 2012/01/01 (HMM).\newline
+There are no options to be used.\newline
+
+\noindent For more details please see the documentation!\newline
+
+\noindent Save per page about $200\unit{ml}$ water,
+$2\unit{g}$ CO$_{2}$ and $2\unit{g}$ wood:\newline
+Therefore please print only if this is really necessary.\newline
+
+\noindent This package provides the command \verb|\Romanbar|
+to print bars below and over the following:
+
+\begin{description}
+\item[-] Roman numbers: \verb|\Romanbar{MMXII}| prints \Romanbar{MMXII}
+
+\item[-] Arabic numbers turned into upper-case Roman numbers:\newline
+ \verb|\Romanbar{2012}| prints \Romanbar{2012}
+
+\item[-] negative Arabic numbers turned into upper-case Roman numbers
+ \newline
+ (although historically there were no negative Roman numbers):
+ \newline
+ \verb|\Romanbar{-12}| prints \Romanbar{-12}
+
+\item[-] zero Arabic number ($0$; although historically
+ there was no Roman zero):\newline
+ \verb|\Romanbar{0}| prints \Romanbar{0}
+
+\item[-] some arbitrary text:
+ \verb|\Romanbar{Caesar}| prints \Romanbar{Caesar}\newline
+ (with descenders: \Romanbar{AgjpqyW})
+
+\newcounter{example}
+\setcounter{example}{21}
+
+\item[-] some counter's value:
+ \verb|\Romanbar{\theexample}| prints \Romanbar{\theexample}
+ \newline
+ (where the value of \texttt{example} is \theexample)
+
+\item[-] Arabic numbers, without turning them into upper-case Roman
+ numbers:\newline
+ \verb|\Romanbar{\relax 2012}| prints \Romanbar{\relax 2012}
+\end{description}
+
+Special care was taken for "L" (50), e.\,g. in 555/DLV: \Romanbar{555}.\\
+
+\verb|\romannum{...}| converts an Arabic number into a lower-case Roman one,
+e.\,g. \verb|\romannum{2012}| prints \romannum{2012}, and
+\verb|\Romannum{...}| converts an Arabic number into an upper-case Roman one,
+e.\,g. \verb|\Romannum{2012}| prints \Romannum{2012}.
+
+\end{document}
+\endinput
+%%
+%% End of file `romanbar-example.tex'.
diff --git a/Master/texmf-dist/doc/latex/romanbar/romanbar.pdf b/Master/texmf-dist/doc/latex/romanbar/romanbar.pdf
new file mode 100644
index 00000000000..fca82264562
--- /dev/null
+++ b/Master/texmf-dist/doc/latex/romanbar/romanbar.pdf
Binary files differ