From 9f37dca95975fe7b71fe79db55788e332b6b704e Mon Sep 17 00:00:00 2001 From: Frank Morgner Date: Fri, 20 Jun 2014 08:32:10 +0200 Subject: [PATCH] working on documentation --- doc/bilder/tikzstyles.tex | 2 +- remote-reader/doc/README.txt | 4 ++ .../doc/relay-note.txt | 0 virtualsmartcard/doc/README.txt | 50 ++++++++----------- virtualsmartcard/doc/README.txt.in | 50 ++++++++----------- 5 files changed, 45 insertions(+), 61 deletions(-) rename {virtualsmartcard => remote-reader}/doc/relay-note.txt (100%) diff --git a/doc/bilder/tikzstyles.tex b/doc/bilder/tikzstyles.tex index 361ad6f..e00f0a8 100644 --- a/doc/bilder/tikzstyles.tex +++ b/doc/bilder/tikzstyles.tex @@ -6,7 +6,7 @@ \definecolor{huslateblue}{cmyk}{0.10, 0.00, 0.00, 0.20} \tikzstyle{kleiner}=[font={\footnotesize}] \tikzstyle{klein}=[font={\small}] -\tikzstyle{box}=[line width=2pt, draw=huslateblue, rounded corners, inner +\tikzstyle{box}=[align=center, line width=2pt, draw=huslateblue, rounded corners, inner sep=.2cm, shadeslate, drop shadow={opacity=.15}, shadow scale=1.05] \tikzstyle{aktivbox}=[box, darkshadeslate] \tikzstyle{nichtrundelinie}=[line width=2pt, draw=hublue, kleiner, color=hublue] diff --git a/remote-reader/doc/README.txt b/remote-reader/doc/README.txt index 06fe5ce..4fb183d 100644 --- a/remote-reader/doc/README.txt +++ b/remote-reader/doc/README.txt @@ -87,6 +87,10 @@ other computer, the :ref:`vicc` in relay mode can be used: \end{pgfonlayer} + +.. include:: relay-note.txt + + ******************** Download and Install ******************** diff --git a/virtualsmartcard/doc/relay-note.txt b/remote-reader/doc/relay-note.txt similarity index 100% rename from virtualsmartcard/doc/relay-note.txt rename to remote-reader/doc/relay-note.txt diff --git a/virtualsmartcard/doc/README.txt b/virtualsmartcard/doc/README.txt index e9fc455..d4af28a 100644 --- a/virtualsmartcard/doc/README.txt +++ b/virtualsmartcard/doc/README.txt @@ -48,36 +48,27 @@ reader. The file :file:`utils.py` was taken from Henryk Plötz's cyberflex-shell_. -.. tikz:: Virtual Smart Card used with PCSC-Lite +.. tikz:: Virtual Smart Card used with PCSC-Lite or WinSCard :stringsubst: :libs: arrows, calc, fit, patterns, plotmarks, shapes.geometric, shapes.misc, shapes.symbols, shapes.arrows, shapes.callouts, shapes.multipart, shapes.gates.logic.US, shapes.gates.logic.IEC, er, automata, backgrounds, chains, topaths, trees, petri, mindmap, matrix, calendar, folding, fadings, through, positioning, scopes, decorations.fractals, decorations.shapes, decorations.text, decorations.pathmorphing, decorations.pathreplacing, decorations.footprints, decorations.markings, shadows \input{%(wd)s/bilder/tikzstyles.tex} \node (pcsclite) - [klein, aktivbox, shape=rectangle split, rectangle split parts=3, inner xsep=3em] - {PCSC-Lite - \nodepart{second} - \footnotesize \texttt{libpcsclite} - \nodepart{third} - \footnotesize \texttt{pcscd} + [klein, aktivbox, inner xsep=.7cm, text width=3cm] + {PC/SC Framework\\\ + (native) }; - \node (pcsc) [box, kleiner, at=(pcsclite.two west)] {PC/SC}; - \node (sca) [aktivbox, klein, left=of pcsc, align=center] {Smart Card\\Application}; - \node (vpcd) [box, at=(pcsclite.three east)] {\texttt{vpcd}}; - \node (vicc) [aktivbox, right=of vpcd] {\texttt{vicc}}; + \node (sca) [aktivbox, klein, left=of pcsclite] {Smart Card\\Application}; + \node (vpcd) [box, at=(pcsclite.east), xshift=-.3cm] {\texttt{vpcd}}; + \node (vicc) [aktivbox, right=of pcsclite] {\texttt{vicc}}; \begin{pgfonlayer}{background} \path[linie] - (sca) edge (pcsc) + (sca) edge (pcsclite) (vpcd) edge (vicc) ; \end{pgfonlayer} -.. versionadded:: 0.7 - We implemented |vpcd| as user mode device driver for Windows so that - |vpicc| can directly be used in Windows' smart card applications that use - PC/SC. - .. versionadded:: 0.7 The Virtual Smart Card optionally brings its own standalone implementation of PC/SC. This allows accessing |vpicc| without PCSC-Lite. Our PC/SC @@ -90,27 +81,21 @@ The file :file:`utils.py` was taken from Henryk Plötz's cyberflex-shell_. \input{%(wd)s/bilder/tikzstyles.tex} \node (pcsclite) - [box, shape=rectangle split, rectangle split parts=2, inner xsep=3em] - {Virtual Smart Card - \nodepart{second} - \footnotesize \texttt{libpcsclite} with \texttt{vpcd} + [klein, box, text width=4cm] + {Virtual Smart Card's\\ + PC/SC Framework }; - \node (pcsc) [box, kleiner, at=(pcsclite.two west)] {PC/SC}; - \node (sca) [aktivbox, klein, left=of pcsc, align=center] {Smart Card\\Application}; - \node (vicc) [aktivbox, right=of pcsclite.two east] {\texttt{vicc}}; + \node (sca) [aktivbox, klein, left=of pcsclite] {Smart Card\\Application}; + \node (vicc) [aktivbox, right=of pcsclite] {\texttt{vicc}}; \begin{pgfonlayer}{background} \path[linie] - (sca) edge (pcsc) - (pcsclite.two east) edge (vicc) + (sca) edge (pcsclite) + (pcsclite) edge (vicc) ; \end{pgfonlayer} - -.. include:: relay-note.txt - - .. include:: download.txt @@ -133,6 +118,11 @@ the following: Building and installing |vpcd| on Windows ================================================================================ +.. versionadded:: 0.7 + We implemented |vpcd| as user mode device driver for Windows so that + |vpicc| can directly be used in Windows' smart card applications that use + PC/SC. + For the Windows integration we extended `Fabio Ottavi's UMDF Driver for a Virtual Smart Card Reader`_ with a |vpcd| interface. To build |vpcd| for Windows we use `Windows Driver Kit 8.1 and Visual Studio 2013`_: diff --git a/virtualsmartcard/doc/README.txt.in b/virtualsmartcard/doc/README.txt.in index cc584c3..e737f3d 100644 --- a/virtualsmartcard/doc/README.txt.in +++ b/virtualsmartcard/doc/README.txt.in @@ -48,36 +48,27 @@ reader. The file :file:`utils.py` was taken from Henryk Plötz's cyberflex-shell_. -.. tikz:: @PACKAGE_NAME@ used with PCSC-Lite +.. tikz:: @PACKAGE_NAME@ used with PCSC-Lite or WinSCard :stringsubst: :libs: arrows, calc, fit, patterns, plotmarks, shapes.geometric, shapes.misc, shapes.symbols, shapes.arrows, shapes.callouts, shapes.multipart, shapes.gates.logic.US, shapes.gates.logic.IEC, er, automata, backgrounds, chains, topaths, trees, petri, mindmap, matrix, calendar, folding, fadings, through, positioning, scopes, decorations.fractals, decorations.shapes, decorations.text, decorations.pathmorphing, decorations.pathreplacing, decorations.footprints, decorations.markings, shadows \input{%(wd)s/bilder/tikzstyles.tex} \node (pcsclite) - [klein, aktivbox, shape=rectangle split, rectangle split parts=3, inner xsep=3em] - {PCSC-Lite - \nodepart{second} - \footnotesize \texttt{libpcsclite} - \nodepart{third} - \footnotesize \texttt{pcscd} + [klein, aktivbox, inner xsep=.7cm, text width=3cm] + {PC/SC Framework\\\ + (native) }; - \node (pcsc) [box, kleiner, at=(pcsclite.two west)] {PC/SC}; - \node (sca) [aktivbox, klein, left=of pcsc, align=center] {Smart Card\\Application}; - \node (vpcd) [box, at=(pcsclite.three east)] {\texttt{vpcd}}; - \node (vicc) [aktivbox, right=of vpcd] {\texttt{vicc}}; + \node (sca) [aktivbox, klein, left=of pcsclite] {Smart Card\\Application}; + \node (vpcd) [box, at=(pcsclite.east), xshift=-.3cm] {\texttt{vpcd}}; + \node (vicc) [aktivbox, right=of pcsclite] {\texttt{vicc}}; \begin{pgfonlayer}{background} \path[linie] - (sca) edge (pcsc) + (sca) edge (pcsclite) (vpcd) edge (vicc) ; \end{pgfonlayer} -.. versionadded:: 0.7 - We implemented |vpcd| as user mode device driver for Windows so that - |vpicc| can directly be used in Windows' smart card applications that use - PC/SC. - .. versionadded:: 0.7 The @PACKAGE_NAME@ optionally brings its own standalone implementation of PC/SC. This allows accessing |vpicc| without PCSC-Lite. Our PC/SC @@ -90,27 +81,21 @@ The file :file:`utils.py` was taken from Henryk Plötz's cyberflex-shell_. \input{%(wd)s/bilder/tikzstyles.tex} \node (pcsclite) - [box, shape=rectangle split, rectangle split parts=2, inner xsep=3em] - {@PACKAGE_NAME@ - \nodepart{second} - \footnotesize \texttt{libpcsclite} with \texttt{vpcd} + [klein, box, text width=4cm] + {@PACKAGE_NAME@'s\\ + PC/SC Framework }; - \node (pcsc) [box, kleiner, at=(pcsclite.two west)] {PC/SC}; - \node (sca) [aktivbox, klein, left=of pcsc, align=center] {Smart Card\\Application}; - \node (vicc) [aktivbox, right=of pcsclite.two east] {\texttt{vicc}}; + \node (sca) [aktivbox, klein, left=of pcsclite] {Smart Card\\Application}; + \node (vicc) [aktivbox, right=of pcsclite] {\texttt{vicc}}; \begin{pgfonlayer}{background} \path[linie] - (sca) edge (pcsc) - (pcsclite.two east) edge (vicc) + (sca) edge (pcsclite) + (pcsclite) edge (vicc) ; \end{pgfonlayer} - -.. include:: relay-note.txt - - .. include:: download.txt @@ -133,6 +118,11 @@ the following: Building and installing |vpcd| on Windows ================================================================================ +.. versionadded:: 0.7 + We implemented |vpcd| as user mode device driver for Windows so that + |vpicc| can directly be used in Windows' smart card applications that use + PC/SC. + For the Windows integration we extended `Fabio Ottavi's UMDF Driver for a Virtual Smart Card Reader`_ with a |vpcd| interface. To build |vpcd| for Windows we use `Windows Driver Kit 8.1 and Visual Studio 2013`_: