diff options
Diffstat (limited to 'Master/texmf-dist/doc/latex/knowledge')
| -rw-r--r-- | Master/texmf-dist/doc/latex/knowledge/README.txt | 22 | ||||
| -rw-r--r-- | Master/texmf-dist/doc/latex/knowledge/knowledge-example.tex | 65 | ||||
| -rw-r--r-- | Master/texmf-dist/doc/latex/knowledge/makefile | 73 |
3 files changed, 138 insertions, 22 deletions
diff --git a/Master/texmf-dist/doc/latex/knowledge/README.txt b/Master/texmf-dist/doc/latex/knowledge/README.txt index 16cb728d87e..e6217ecdcd9 100644 --- a/Master/texmf-dist/doc/latex/knowledge/README.txt +++ b/Master/texmf-dist/doc/latex/knowledge/README.txt @@ -1,8 +1,8 @@ This directory contains the package name: knowledge.sty - version: 1.0 - date: 2017-06-09 + version: 1.04 + date: 2017-07-28 license: LaTeX Project Public License version 1.2 or above author: Thomas Colcombet @@ -18,9 +18,19 @@ references of a concept linked to its introduction. It also offers simple notations. -Content of the file knowledge.zip: +Content of the file knowledge-sources.zip: - README.txt: this file - - knowledge.sty: the package file - - knowledge.pdf: a documentation - - knowledge-example.tex: a minimalist example + - knowledge.sty: the package file (generated) + - knowledge.pdf: the user documentation (generated) + - makefile: the makefile. Use 'make all' + to generate knowledge.sty and knowledge.pdf + - knowledge.dtx: the main file + (compiling it directly yields a developper version of the + documentation that contains the code. Use 'make all' + for the regular version) + - all.ins: file generating knowledge.sty when compiled (docstrip) + - knowledge-configuration.dtx + - knowledge-utils.dtx + - knowledge-example.tex: an example file + diff --git a/Master/texmf-dist/doc/latex/knowledge/knowledge-example.tex b/Master/texmf-dist/doc/latex/knowledge/knowledge-example.tex index 878036ef03d..842d6fbd0e2 100644 --- a/Master/texmf-dist/doc/latex/knowledge/knowledge-example.tex +++ b/Master/texmf-dist/doc/latex/knowledge/knowledge-example.tex @@ -15,15 +15,18 @@ % The package 'knowledge' has now to be loaded. % The options % 'paper', 'electronic' or 'composition' (default) -% can be used. These activates different rendering styles. -% - paper produce a paper to be printed -% - electronic highlights links using color -% - composition (or default) highlights missing knowledges as -% well as other information. It should always be used but when the paper is ready. +% can be used. These activates different rendering styles: +% - 'paper' produce a paper to be printed: +% text in black and white +% - 'electronic' highlights links using colors: +% for being read on an electronic device +% - 'composition' (or default) highlights missing knowledges as +% well as agives other pieces of information. It should always +% be used but when the paper is ready. % -\usepackage{knowledge} % default -%\usepackage[electronic]{knowledge} % final version to be read electronically -%\usepackage[paper]{knowledge} % final version in black and white for printing +\usepackage[scope]{knowledge} % default +%\usepackage[scope,electronic]{knowledge} % final version to be read electronically +%\usepackage[scope,paper]{knowledge} % final version in black and white for printing % % The 'notion' configuration is commonly used for scientific papers. @@ -34,10 +37,12 @@ -% The following -% It is convenient now to provide a list of \knowledge in the preamble: +% It is convenient now to provide a list of \knowledge in the preamble +% (or in an external file) according to the following syntax: +% % \knowledge{knowledge text}[synonym 1|synonym 2|...]{directives} -% Most common in a science paper are 'notion' knowledges that +% +% The most common directive in a science paper is 'notion': knowledges that % are used in the body with \intro and \kl commands/""...""" and "..." notatation: \knowledge{anchor point}[anchor points|Anchor points]{notion} \knowledge{diagnose file}{notion} @@ -53,7 +58,21 @@ % Some other configurations are possible, such as: \knowledge{LaTeX}[latex|LATEX|Latex]{url={https://fr.wikipedia.org/wiki/LaTeX}, text=\LaTeX} -\knowledge{pdflatex}{url={https://en.wikipedia.org/wiki/PdfTeX}, typewriter} + +% Configurations can also be made contextual. For instance, the +% following knowledge is only accessible directly in the introduction. +% It can nevertheless be used from elswhere using "pdflatex@@section:introduction", +\knowledge{pdflatex}{scope={section:example},url={https://en.wikipedia.org/wiki/PdfTeX}, typewriter} +% or \kl(section:introduction){pdflatex}. See 'scoping' in the documetation for more details. + +% Scoping can be used in the preamble. For instance: +\begin{scope}\label{package} + \knowledge{knowledge}{link=knowledge package,link scope} +\end{scope} + + + + \title{Mini example for the \texttt{knowledge} package} @@ -61,9 +80,23 @@ \begin{document} \maketitle \begin{abstract} -\AP This document provides an elementary example of the ""knowledge package"" for "latex". +\AP This document provides an elementary example of the "knowledge package" for "latex". \end{abstract} +\section{Introduction} +\label{section:introduction} + +The package ""knowledge@@package"" is a package for "latex" that helps associating information to terms. This can be used for: +\begin{itemize} +\item managing external urls, for instance separating the file containing the addresses from their use, +\item managing internal references's such as linking every use of a concept to the place of its introduction (in particular avoiding the use of labels), +\item managing the index in a centralized way, +\item replacing some macros for configuring the display. +\end{itemize} +Primarily, the goal of the "knowledge@@package" is for the production of scientific documents (the longer, the more interesting, such as a thesis or a book) in order to improve their readability on electronic devices. Ultimately, the goal is to produce documents that are more semantic-aware. Some capabilities (link handling the index) are not related to this purpose in particular. + +\section{Example running} +\label{section:example} Try compiling this document (two compilation phases to have proper links) using "pdflatex", and see how some notions are hyperlinked to their introduction point (some viewers make it more obvious than others by displaying a preview of the target of a link inside a document; since there is only one page in this example, this may be worth zooming in this case). \AP When the "paper mode" is not active, links are clearly identified in blue. Try then compiling it in ""paper mode"" (an option of the "knowledge package"); it now looks like a regular paper (but the links are still there). In ""electronic mode"", the links are still colored, but some other hints disappear like "anchor points". @@ -89,8 +122,8 @@ The `@' symbol allows some flexibility by having a displayed text different from \begin{quote} \verb|\knowledge|\texttt{\{name\}[synonym1|synonym2|...]\{directives\}} \end{quote} -However, using undefined "knowledges" will not cause compile time errors, but be displayed as in the following `"unknown knowledge"' (i.e. in non-"paper mode" in brown, but in regular black in "paper mode" or "electronic mode"). \AP The ""diagnose file"" (that ends with a \texttt{.diagnose} extension) contains detailed information about these warnings, and should be read often when finalising the document. +However, using undefined "knowledges" will not cause compile time errors, but be displayed as in the following `"unknown knowledge"' (i.e. in non-"paper mode" in brown, but in regular black in "paper mode" or "electronic mode"). \AP The ""diagnose file"" (that ends with a \texttt{.diagnose} extension) contains detailed information about these warnings, and should be read often when finalizing the document. -\AP Small red corners are visible in the margin. These are called ""anchor points"", are introduced -using the \texttt{\detokenize{\AP}}command usually at the beginning of each paragraph that introduce some concept, or even in the middle of the paragraph. The "anchor points" become invisible in "paper@paper mode" or "electronic mode". +\AP Small red corners are visible in the margin. These are called ""anchor points"" and are introduced +using the \texttt{\detokenize{\AP}}command, commonly at the beginning of each paragraph that introduce some concept, or even in the middle of the paragraph. The "anchor points" become invisible in "paper@paper mode" or "electronic mode". \end{document}
\ No newline at end of file diff --git a/Master/texmf-dist/doc/latex/knowledge/makefile b/Master/texmf-dist/doc/latex/knowledge/makefile new file mode 100644 index 00000000000..ddc1bfe8bcf --- /dev/null +++ b/Master/texmf-dist/doc/latex/knowledge/makefile @@ -0,0 +1,73 @@ +help: + echo "- help : this help" + echo "- all: produces knowledge.pdf and knowledge.sty" + echo "- ctan: creates the knowledge-ctan.zip file for CTAN" + echo "- clean" + echo "- knowledge.zip" + echo "- knowledge-sources.zip" + echo "- sources" + +all: +knowledge.sty: knowledge.dtx knowledge-utils.dtx knowledge-configuration.dtx + latex all.ins + + +clean: + make -CRegression clean + rm -f *.aux *.glo *.idx *.aux *.synctex.gz *.out *.toc *.kaux *.diagnose *.log + rm -f *.bbl *.out *.bbl *.ind *.ilg *.idx + rm -f knowledge.sty + rm -f knowledge.pdf knowledge-utils.pdf knowledge-configuration.pdf knowledge-example.pdf + rm -f knowledge-sources.zip knowledge-sources-complete.zip knowledge.zip + rm -f knowledge-ctan.zip + + +ctan: knowledge-ctan.zip + +knowledge.pdf:knowledge.aux + pdflatex "\def\nocode{1} \input{knowledge.dtx}" + pdflatex "\def\nocode{1} \input{knowledge.dtx}" + pdflatex "\def\nocode{1} \input{knowledge.dtx}" + + +knowledge.aux: knowledge.dtx knowledge.sty + pdflatex knowledge.dtx + +sources: clean knowledge-sources.zip knowledge-sources-complete.zip + +knowledge-sources-complete.zip: clean + \rm -f knowledge-sources-complete.zip + zip knowledge-sources-complete.zip *.* makefile Regression/* + cp knowledge-sources-complete.zip ../knowledge-sources-complete-`date +%y-%m-%d_%H:%M`.zip + +knowledge-ctan.zip: knowledge.pdf knowledge.sty all.ins README.txt makefile + rm -f knowledge-ctan.zip + rm -rf knowledge + mkdir knowledge + cp knowledge.pdf knowledge.sty knowledge/ + cp knowledge.dtx knowledge-utils.dtx knowledge-configuration.dtx knowledge/ + cp makefile all.ins knowledge-example.tex README.txt knowledge/ + zip knowledge-ctan.zip knowledge/* + rm -rf knowledge + + +knowledge-sources.zip: knowledge.dtx + rm -f knowledge-sources.zip + zip knowledge-sources.zip makefile knowledge.dtx knowledge-utils.dtx knowledge-configuration.dtx all.ins knowledge-example.tex README.txt + cp knowledge-sources.zip ../knowledge-sources-`date +%y-%m-%d_%H:%M`.zip + +knowledge.zip: knowledge.pdf knowledge.sty knowledge-example.tex README.txt + rm -f knowledge.zip + rm -rf knowledge + mkdir knowledge + cp knowledge.pdf knowledge.sty knowledge-example.tex README.txt knowledge/ + zip knowledge.zip knowledge/* + rm -rf knowledge + +publish: knowledge.zip knowledge-sources.zip + cp knowledge.pdf ~/Travail/Web/public_html/Knowledge/ + cp knowledge.zip ~/Travail/Web/public_html/Knowledge/knowledge--lastversion.zip + cp knowledge.zip ~/Travail/Web/public_html/Knowledge/knowledge-`date +%Y-%m-%d`.zip + cp knowledge-sources.zip ~/Travail/Web/public_html/Knowledge/knowledge-sources-`date +%Y-%m-%d`.zip + + |