[latex3-commits] [git/LaTeX3-latex3-hyperref] master: Update README.md (#119) (e79553a)
David Carlisle
d.p.carlisle at gmail.com
Fri Jan 24 09:01:56 CET 2020
Repository : https://github.com/latex3/hyperref
On branch : master
Link : https://github.com/latex3/hyperref/commit/e79553af4a6695a628216f78ff1a7f8f6754f106
>---------------------------------------------------------------
commit e79553af4a6695a628216f78ff1a7f8f6754f106
Author: Pablo González Luengo <pablgonz at yahoo.com>
Date: Fri Jan 24 05:01:56 2020 -0300
Update README.md (#119)
Small modifications to make it compatible with https://www.ctan.org/markdown
Update Version and date
>---------------------------------------------------------------
e79553af4a6695a628216f78ff1a7f8f6754f106
README.md | 67 +++++++++++++++++++++++++--------------------------------------
1 file changed, 27 insertions(+), 40 deletions(-)
diff --git a/README.md b/README.md
index 2088201..5a2c53f 100644
--- a/README.md
+++ b/README.md
@@ -1,13 +1,12 @@
# README for hyperref bundle
-2020-01-14
+Version v7.00d 2020-01-14
## INTRODUCTION
-
This package is used to emend cross-referencing commands in LaTeX to
-produce some sort of \special commands; there are backends for the
-\special set defined for HyperTeX dvi processors, for embedded pdfmark
+produce some sort of `\special` commands; there are backends for the
+`\special` set defined for HyperTeX dvi processors, for embedded pdfmark
commands for processing by Acrobat Distiller (dvips and dvipsone), for
dviwindo, for pdfTeX, for dvipdfm, for TeX4ht, and for VTEX's pdf and HTML
backends.
@@ -17,36 +16,32 @@ Included are:
1. `hyperref` The main hyperlinking functionality.
2. `backref` a package by David Carlisle to provide links back from
bibliography to the main text; these are hypertext links after using
- hyperref.
+ `hyperref`.
3. `nameref` a package to allow reference to the *names* of sections rather
than their numbers.
## DOWNLOAD
-
-`hyperref` is available on CTAN:
- https://ctan.org/pkg/hyperref
+`hyperref` is available on CTAN:https://ctan.org/pkg/hyperref
Also a ZIP file is provided that contains the files, already sorted
in a TDS tree:
- CTAN:install/macros/latex/contrib/hyperref.tds.zip
+ CTAN:http://mirrors.ctan.org/install/macros/latex/contrib/hyperref.tds.zip
"CTAN:" means one of the 'Comprehensive TeX Archive Network'
nodes or one of its mirrors. This is explained in
https://texfaq.org/FAQ-archives
The main repository of hyperref is located at github
- https://github.com/latex3/hyperref
-
+ https://github.com/latex3/hyperref
## INSTALLATION
-
### Installation with ZIP file in TDS format
-The ZIP file `hyperref.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.)
+The ZIP file [hyperref.tds.zip](http://mirrors.ctan.org/install/macros/latex/contrib/hyperref.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](https://ctan.org/pkg/tds) for an explanation of TDS.)
Example:
```
@@ -54,42 +49,38 @@ Example:
unzip /...downloadpath.../hyperref.tds.zip
```
-Do not forget to refresh the file name database of this TDS tree,
-Example:
+Do not forget to refresh the file name database of this TDS tree.
+Example for TeXLive:
```
- texhash /...somewhere.../texmf
+ mktexlsr /...somewhere.../texmf
```
### Manual installation
1. Download the hyperref files from CTAN or the TUG server.
If necessary, unpack them.
- 2. Generate the package and driver files:
- tex hyperref.ins
+ 2. Generate the package and driver files: `tex hyperref.ins`
3. Install the files `*.sty`, `*.def`, and `*.cfg` in your TDS tree:
- cp *.sty *.def *.cfg TDS:tex/latex/hyperref/
- Replace `TDS:` by the prefix of your TDS tree (texmf directory).
- The exception is bmhydoc.sty, it belongs to the source files
- (TDS:source/latex/hyperref/).
- 4. Copy the documentation files to "TDS:doc/latex/hyperref/":
+ `cp *.sty *.def *.cfg TDS:tex/latex/hyperref/`.
+ Replace `TDS:` by the prefix of your TDS tree (`texmf` directory).
+ The exception is `bmhydoc.sty`, it belongs to the source files
+ (`TDS:source/latex/hyperref/`).
+ 4. Copy the documentation files to "`TDS:doc/latex/hyperref/`":
manual.pdf, README.md, ChangeLog.txt,
slides.pdf, paper.pdf, hyperref.pdf, backref.pdf,
- nameref.pdf (Also the HTML version of the manual can be put there.)
- 5. Update the databases if necessary, eg. for texlive:
- mktexlsr .../texmf
+ nameref.pdf (Also the HTML version of the manual can be put there).
+ 5. Update the databases if necessary, eg. for TeXLive:
+ `mktexlsr .../texmf`
## AUTHORS/MAINTAINERS
-
* Sebastian Rahtz (died 2016)
* Heiko Oberdiek (inactive)
* The LaTeX3 Project
-
## BUG REPORTS
-
A bug report should contain:
* Comprehensive problem description. This includes error or
@@ -100,7 +91,7 @@ A bug report should contain:
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
+ * If you are using LaTeX, then add "`\listfiles`". Then
a list of version informations is printed at the end
of the LaTeX run.
* Please no other files than the minimal test file.
@@ -112,23 +103,21 @@ A bug report should contain:
A bug tracker is available at github:
https://github.com/latex3/hyperref/issues
-
## Vietnamese part
Responsible for the Vietnamese translations of the
\autoref names and puvnenc.def are:
- Han The Thanh <hanthethanh [at] gmail [dot] com>
- Reinhard Kotucha <reinhard [dot] kotucha at web [dot] de>
+
+- Han The Thanh `<hanthethanh [at] gmail [dot] com>`
+- Reinhard Kotucha `<reinhard [dot] kotucha at web [dot] de>`
## Arabic part
Responsible for the additions to PU encoding for Arabi is
- Youssef Jabri <yjabri [at] ensa [dot] univ-oujda [dot] ac [dot] ma>
-
+ Youssef Jabri `<yjabri [at] ensa [dot] univ-oujda [dot] ac [dot] ma>`
## KNOWN PROBLEMS
-
* (half-done) hyper images (link from thumbnail in text)
* Relative links are not sorted out or documented well.
For PDF generation:
@@ -143,7 +132,6 @@ Responsible for the additions to PU encoding for Arabi is
```
* ...
-
## TODO
* modules
@@ -157,4 +145,3 @@ Responsible for the additions to PU encoding for Arabi is
nested links. The start positions should be remembered in a stack,
but there are complications with page breaks.
* ...
-
More information about the latex3-commits
mailing list