summaryrefslogtreecommitdiff
path: root/Master/texmf-dist/doc/latex
diff options
context:
space:
mode:
authorKarl Berry <karl@freefriends.org>2015-08-03 22:04:15 +0000
committerKarl Berry <karl@freefriends.org>2015-08-03 22:04:15 +0000
commit8861879f68d110b9c3cbb9b4153c28e5e3799b9d (patch)
tree8e752c737bc3f1ab9397caecd532324dd72dbdfe /Master/texmf-dist/doc/latex
parent0ae7a590ae93af9b84a61f599507ec81ae1b61cf (diff)
alertmessage (3aug15)
git-svn-id: svn://tug.org/texlive/trunk@38034 c570f23f-e606-0410-a88d-b1316a301751
Diffstat (limited to 'Master/texmf-dist/doc/latex')
-rw-r--r--Master/texmf-dist/doc/latex/alertmessage/README.md55
-rw-r--r--Master/texmf-dist/doc/latex/alertmessage/alertmessage.pdfbin0 -> 106836 bytes
-rw-r--r--Master/texmf-dist/doc/latex/alertmessage/img/alertmessage-error.pngbin0 -> 1415 bytes
-rw-r--r--Master/texmf-dist/doc/latex/alertmessage/img/alertmessage-info.pngbin0 -> 1561 bytes
-rw-r--r--Master/texmf-dist/doc/latex/alertmessage/img/alertmessage-success.pngbin0 -> 1202 bytes
-rw-r--r--Master/texmf-dist/doc/latex/alertmessage/img/alertmessage-warning.pngbin0 -> 1418 bytes
6 files changed, 55 insertions, 0 deletions
diff --git a/Master/texmf-dist/doc/latex/alertmessage/README.md b/Master/texmf-dist/doc/latex/alertmessage/README.md
new file mode 100644
index 00000000000..6a8328f0cbf
--- /dev/null
+++ b/Master/texmf-dist/doc/latex/alertmessage/README.md
@@ -0,0 +1,55 @@
+# latex-alert-message
+Alert messages for LaTeX - Inspired by [Bootstrap alerts](http://www.w3schools.com/bootstrap/bootstrap_alerts.asp)
+
+![Example rendering](https://github.com/pidupuis/latex-alert-message/blob/master/panels.png)
+
+## Installation
+
+#### Clean installation
+
+To install the package properly, download the [TDS archive](https://github.com/pidupuis/latex-alert-message/blob/master/alertmessage.tds.zip?raw=true).
+
+```bash
+# Extract the archive into the texmf folder
+sudo unzip alertmessage.tds.zip -d "$(kpsewhich -var-value TEXMFLOCAL)"
+# Then update the package list
+sudo texhash
+```
+
+The package will be available from anywhere on your computer.
+
+#### Use the package without installation
+
+You can use the package without installation by putting the [package file](https://raw.githubusercontent.com/pidupuis/latex-alert-message/master/alertmessage.sty) and the [images](https://github.com/pidupuis/latex-alert-message/tree/master/img) in the root directory of your LaTeX project.
+
+Download the [latest release](https://github.com/pidupuis/latex-alert-message/releases/tag/v1.0) as a full example project or look at the [example.tex](https://github.com/pidupuis/latex-alert-message/blob/master/example.tex).
+
+## Documentation
+
+Include the package in the header of your TeX file:
+```tex
+\usepackage{alertmessage}
+```
+
+And simply call the methods you need. There are four panels availables for `information`, `warnings`, `errors` or `success` messages.
+
+```tex
+\alertinfo{Lorem ipsum dolor sit amet.}
+\alertsuccess{Lorem ipsum dolor sit amet.}
+\alertwarning{Lorem ipsum dolor sit amet.}
+\alerterror{Lorem ipsum dolor sit amet.}
+```
+
+The panel will adapt its size according to the length of the text (as you can see in the example).
+
+## Contributing
+
+Feel free to open [issues](https://github.com/pidupuis/latex-alert-message/issues) or create [pull requests](https://github.com/pidupuis/latex-alert-message/pulls).
+
+If you want to modify the package for personal use, you can manually edit the [package file](https://github.com/pidupuis/latex-alert-message/blob/master/alertmessage.sty).
+
+If you want to create a TDS archive to share your modifications with your friends, use the [TDS generation script](https://github.com/pidupuis/latex-alert-message/blob/master/generate_tds.sh).
+
+If you want to deploy your modifications on the CTAN by yourself, please take a different package name.
+
+
diff --git a/Master/texmf-dist/doc/latex/alertmessage/alertmessage.pdf b/Master/texmf-dist/doc/latex/alertmessage/alertmessage.pdf
new file mode 100644
index 00000000000..395e7ac5338
--- /dev/null
+++ b/Master/texmf-dist/doc/latex/alertmessage/alertmessage.pdf
Binary files differ
diff --git a/Master/texmf-dist/doc/latex/alertmessage/img/alertmessage-error.png b/Master/texmf-dist/doc/latex/alertmessage/img/alertmessage-error.png
new file mode 100644
index 00000000000..50b604fb9e2
--- /dev/null
+++ b/Master/texmf-dist/doc/latex/alertmessage/img/alertmessage-error.png
Binary files differ
diff --git a/Master/texmf-dist/doc/latex/alertmessage/img/alertmessage-info.png b/Master/texmf-dist/doc/latex/alertmessage/img/alertmessage-info.png
new file mode 100644
index 00000000000..3e841c9e727
--- /dev/null
+++ b/Master/texmf-dist/doc/latex/alertmessage/img/alertmessage-info.png
Binary files differ
diff --git a/Master/texmf-dist/doc/latex/alertmessage/img/alertmessage-success.png b/Master/texmf-dist/doc/latex/alertmessage/img/alertmessage-success.png
new file mode 100644
index 00000000000..0a2b4f3258b
--- /dev/null
+++ b/Master/texmf-dist/doc/latex/alertmessage/img/alertmessage-success.png
Binary files differ
diff --git a/Master/texmf-dist/doc/latex/alertmessage/img/alertmessage-warning.png b/Master/texmf-dist/doc/latex/alertmessage/img/alertmessage-warning.png
new file mode 100644
index 00000000000..01ad7d03840
--- /dev/null
+++ b/Master/texmf-dist/doc/latex/alertmessage/img/alertmessage-warning.png
Binary files differ