summaryrefslogtreecommitdiff
path: root/Master/texmf-dist/doc/latex/interfaces
diff options
context:
space:
mode:
authorKarl Berry <karl@freefriends.org>2010-10-25 23:12:18 +0000
committerKarl Berry <karl@freefriends.org>2010-10-25 23:12:18 +0000
commitd74b95d250c7632cb73e7420db04e2e38adc3827 (patch)
treefbc6763253fbb9d309da7b613857d782ee5feccb /Master/texmf-dist/doc/latex/interfaces
parentec47c1b7880fd4f626f8aa8377e576e03d72c24f (diff)
new latex package interfaces (25oct10)
git-svn-id: svn://tug.org/texlive/trunk@20206 c570f23f-e606-0410-a88d-b1316a301751
Diffstat (limited to 'Master/texmf-dist/doc/latex/interfaces')
-rw-r--r--Master/texmf-dist/doc/latex/interfaces/README71
-rw-r--r--Master/texmf-dist/doc/latex/interfaces/interfaces-hypbmsec.code.tex149
-rw-r--r--Master/texmf-dist/doc/latex/interfaces/interfaces.pdfbin0 -> 1606644 bytes
3 files changed, 220 insertions, 0 deletions
diff --git a/Master/texmf-dist/doc/latex/interfaces/README b/Master/texmf-dist/doc/latex/interfaces/README
new file mode 100644
index 00000000000..5da9c8dd050
--- /dev/null
+++ b/Master/texmf-dist/doc/latex/interfaces/README
@@ -0,0 +1,71 @@
+Interfaces provides a small number of macros to modify the settings
+^^^^^^^^^^ of a large number of parameters provided by Most Frequently
+ Used Packages (MFUP!) for typesetting beautiful documents with LaTeX.
+
+The macros shares a standardized syntax of the form key=value. The key
+names are intuitive: font, top, bottom, left, right, bookmark, bold,
+italic, color, twocolumns, title, pagestyle, before, after, indent etc.
+
+Interfaces DOES NOT provide any new feature, except \repeatcell,
+\rowfont, and \bookmarksetup (as long as the bookmark package does not
+`steal' them to interfaces... what whould be considered as a favour!)
+
+A few macros are modified. The complete list is included in
+interfaces.pdf, with explainations.
+
+ * * * *
+Interfaces is organised in different modules which are loaded after
+the master package is loaded. Each module can be loaded separately.
+
+Commands provided: (each in a distinct module) -----------------------
+
+\sectionformat: interface for package titlesec to modify the titles
+ produced by the sectionning commands (and their bookmarks).
+ replaces \titleformat, \titlespacing and \titleclass and
+ is compatible with them.
+
+\pagesetup: interface for package fancyhdr to modify the current page
+ style or create new page styles. Replaces \fancypagestyle
+ \fancyhf, \fancyhfoffset, \renewcommand\headrulewidth etc.
+
+\tocsetup: interface for package tocloft to fine tune the aspect of
+ the table of contents, list of figures / of tables. \tocsetup also
+ applies to \shorttableofcontents provided by the shorttoc package.
+ Facility to make multi-columns table(s) of contents is included,
+ give a label for the table of contents/of figures/of tables...
+ give them a bookmark. Replaces a lot of tocloft' control sequences.
+
+\repeatcell: to create `dynamic' tabulars, possibly with formulas
+ computation: \numexpr, \pgfmathparse or \FPeval formulas can be
+ plugged in the tabular or array, with the possibility to transpose.
+
+\rowfont: to modify the font and/or the alignment of each cell in a
+ tabular/array row. Modification of the alignment has some limitations.
+ Compatible with all package compatible with array.sty,colortbl,hhline,
+ arydshln,delarray etc.
+
++ some macros to make easier the use of e-TeX \marks registers (useful
+ with \sectionformat and \pagesetup).
+
+\trunctext and \htruncadjust are provided in order to take advantage of
+ the code provided by the package truncate.sty
+-----------------------------------------------------------------------
+
+Interfaces is mainly based on scrlfile.sty ( provided in the Koma-
+ Script bundle, but Koma-Script classes are not required), on pgfkeys
+ and etoolbox.
+
+Interfaces defines some pgfkeys handlers designed specially to make
+key-value interfaces for other packages. Using those handlers permit
+the design of an interface in a few minutes... (well, good knowledge
+of pgfkeys is required ;-)
+
+. \bookmarksetup is also enhanced with starred keys.
+
+. Facility to load TikZ libraries and pgf modules is provided via \usetikz.
+
+. \pgfkeys is enhanced with a new ``default'' value in case the value is blank.
+
+. scrlfile's \AfterFile and \BeforeFile have starred forms.
+-----------------------------------------------------------------------
+(c) lppl 2010 FC. \ No newline at end of file
diff --git a/Master/texmf-dist/doc/latex/interfaces/interfaces-hypbmsec.code.tex b/Master/texmf-dist/doc/latex/interfaces/interfaces-hypbmsec.code.tex
new file mode 100644
index 00000000000..387e73fbc4f
--- /dev/null
+++ b/Master/texmf-dist/doc/latex/interfaces/interfaces-hypbmsec.code.tex
@@ -0,0 +1,149 @@
+%%
+%% This is file `interfaces-hypbmsec.code.tex',
+%% generated with the docstrip utility.
+%%
+%% The original source files were:
+%%
+%% interfaces.dtx (with options: `hypbmsec.code.tex')
+%%
+%% This is a generated file.
+%%
+%% interfaces : 2010/10/20 v1.0 - interfaces : interfaces with keys for other packages (FC)
+%%
+%% 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
+%%
+%% This work consists of the main source file interfaces.dtx
+%% and the derived files
+%% interfaces.sty, interfaces.pdf, interfaces.ins,
+%% interfaces-base.sty,
+%% interfaces-LaTeX.sty,
+%% interfaces-tikz.sty,
+%% interfaces-titlesec.sty,
+%% interfaces-hyperref.sty,
+%% interfaces-bookmark.sty,
+%% interfaces-hypbmsec.sty,interfaces-hypbmsec.code.tex,
+%% interfaces-fancyhdr.sty,
+%% interfaces-marks.sty,
+%% interfaces-tocloft.sty,
+%% interfaces-makecell.sty,
+%% interfaces-enumitem.sty,
+%% interfaces-truncate.sty,
+%% interfaces-appendix.sty,
+%% interfaces-embedfile.sty,
+%% interfaces-environ.sty,
+%% interfaces-umrand.sty,
+%% interfaces-scrlfile.sty,
+%% interfaces-pgfkeys.sty,
+%% interfaces-etoolbox.sty,
+%% interfaces-fancyvrb.sty
+%%
+%% interfaces: interfaces with keys for other packages (FC)
+%% Copyright (C) 2010 by Florent Chervet <florent.chervet@free.fr>
+%%
+\ProvidesFile{hypbmsec.code.tex}
+ [2010/10/05 v1.0 code for interfaces-hypbmsec (FC)]
+\itf@patch\pretocmd\hbs@do{%
+ \edef\itf@tp{\expandafter\itf@strip@at\string#1}%
+ }%
+ {\PackageInfo{interfaces-hypbmsec}
+ {Command \string\hbs@do\space successfully patched}}
+ {\PackageWarning{interfaces-hypbmsec}
+ {Command \string\hbs@do\space could not be patched
+ \MessageBreak loading of `interfaces-hypbmsec` aborted
+ \MessageBreak \string\lastsection\space will not work}%
+ \endinput}%
+\itf@patch\pretocmd\hbs@process{%
+ \itf@hbs@next{#1}%
+ }%
+ {\PackageInfo{interfaces-hypbmsec}
+ {Command \string\hbs@process\space successfully patched}}
+ {\PackageWarning{interfaces-hypbmsec}
+ {Command \string\hbs@process\space could not be patched
+ \MessageBreak loading of `interfaces-hypbmsec` aborted
+ \MessageBreak \string\lastsection\space will not work}%
+ \endinput}%
+\long\def\itf@hbs@next#1{%
+ \csdef{itf@next\itf@tp title}{#1}%
+ \ifx\hbs@tocstring\relax
+ \csletcs{itf@next\itf@tp toc}{itf@next\itf@tp}%
+ \else
+ \cslet{itf@next\itf@tp toc}\hbs@tocstring
+ \fi
+ \ifx\hbs@bmstring\relax
+ \csletcs{itf@next\itf@tp bookmark}{itf@next\itf@tp toc}%
+ \else
+ \cslet{itf@next\itf@tp bookmark}\hbs@bmstring
+ \fi
+ \expandafter\expandafter\expandafter
+ \expandafter\expandafter\expandafter
+ \expandafter\itf@hbs@chkclass
+ \expandafter\expandafter\expandafter\string
+ \expandafter\hbs@seccmd\string\ttl@\@nil
+ {}
+ {\expandafter\itf@last@from@next\expandafter{\itf@tp}}%
+}% \itf@hbs@next
+\edef\itf@tp{%
+ \long\def\noexpand\itf@hbs@chkclass##1\string\ttl@##2\noexpand\@nil{%
+ \noexpand\ifblank{##1}%
+ }% \itf@hbs@chkclass
+}\itf@tp
+\itf@patch\pretocmd\ttl@select{%
+ \itf@last@from@next{#1}}
+ {\PackageInfo{interfaces-hypbmsec}
+ {Command \string\ttl@select\space successfully patched}}
+ {\PackageWarning{interfaces-hypbmsec}
+ {Command \string\ttl@select\space could not be patched
+ \MessageBreak loading of `interfaces-hypbmsec` aborted
+ \MessageBreak \string\lastsection\space will not work}%
+ \endinput}%
+\def\itf@last@from@next#1{%
+ \expandafter\let\csname last#1title\expandafter\endcsname
+ \csname itf@next#1title\endcsname
+ \expandafter\let\csname itf@last#1toc\expandafter\endcsname
+ \csname itf@next#1toc\endcsname
+ \expandafter\let\csname last#1bookmark\expandafter\endcsname
+ \csname itf@next#1bookmark\endcsname
+ \expandafter\def\csname lastsectionname\endcsname{#1}%
+}% \itf@last@from@next
+%%-----------------------------------------------------------------------------
+%% \lastsection reinitialization (at \stepcounter-> \cl@section)
+\def\itf@hbs@resetlast#1{%
+ \ifcsname last#1\endcsname
+ \global\expandafter\let
+ \csname last#1\endcsname\@empty
+ \fi
+}% \itf@hbs@resetlast
+\def\itf@hbs@reset#1{%
+ \itf@hbs@resetlast{#1title}%
+ \itf@hbs@resetlast{#1bookmark}%
+ \itf@hbs@resetlast{#1toc}%
+ \csuse{cl@#1}%
+}% \itf@hbs@reset
+\let\ltx@stpelt\@stpelt
+\def\itf@hbs@stpelt#1{%
+ \let\@elt\itf@hbs@reset
+ \@elt{#1}%
+ \let\@elt\itf@stpelt
+}% \itf@hbs@stpelt
+\def\itf@stpelt#1{%
+ \ltx@stpelt{#1}%
+ \itf@hbs@stpelt{#1}%
+}% \itf@stpelt
+\let\@stpelt\itf@stpelt
+%%-----------------------------------------------------------------------------
+\@for\itf@tp:=part,section,subsection,subsubsection,paragraph,subparagraph%
+ \do{\global\expandafter\let\csname last\itf@tp title\endcsname\@empty
+ \global\expandafter\let\csname last\itf@tp toc\endcsname\@empty
+ \global\expandafter\let\csname last\itf@tp bookmark\endcsname\@empty}%
+\AtBeginDocument{\ifundef\chapter{}
+ {\global\let\lastchaptertitle\@empty
+ \global\let\lastchaptertoc\@empty
+ \global\let\lastchapterbookmark\@empty}%
+}%
+\endinput
+%%
+%% End of file `interfaces-hypbmsec.code.tex'.
diff --git a/Master/texmf-dist/doc/latex/interfaces/interfaces.pdf b/Master/texmf-dist/doc/latex/interfaces/interfaces.pdf
new file mode 100644
index 00000000000..dfd53c0b666
--- /dev/null
+++ b/Master/texmf-dist/doc/latex/interfaces/interfaces.pdf
Binary files differ