summaryrefslogtreecommitdiff
path: root/Master/texmf-dist/doc
diff options
context:
space:
mode:
authorKarl Berry <karl@freefriends.org>2018-06-04 20:52:38 +0000
committerKarl Berry <karl@freefriends.org>2018-06-04 20:52:38 +0000
commite2e3a74fb516651d3e9dff637605f85038e6ae3e (patch)
tree9710f38331a5656d85ea85c4e40344b81a96eefb /Master/texmf-dist/doc
parente0bd44e5ad91047ec422c1467e256bac2589e498 (diff)
scientific-thesis-cover (4jun18)
git-svn-id: svn://tug.org/texlive/trunk@47923 c570f23f-e606-0410-a88d-b1316a301751
Diffstat (limited to 'Master/texmf-dist/doc')
-rw-r--r--Master/texmf-dist/doc/latex/scientific-thesis-cover/CHANGELOG.md64
-rw-r--r--Master/texmf-dist/doc/latex/scientific-thesis-cover/README.md31
-rw-r--r--Master/texmf-dist/doc/latex/scientific-thesis-cover/demo.tex19
-rw-r--r--Master/texmf-dist/doc/latex/scientific-thesis-cover/scientific-thesis-cover.pdfbin0 -> 139935 bytes
4 files changed, 101 insertions, 13 deletions
diff --git a/Master/texmf-dist/doc/latex/scientific-thesis-cover/CHANGELOG.md b/Master/texmf-dist/doc/latex/scientific-thesis-cover/CHANGELOG.md
new file mode 100644
index 00000000000..b1cb41f4603
--- /dev/null
+++ b/Master/texmf-dist/doc/latex/scientific-thesis-cover/CHANGELOG.md
@@ -0,0 +1,64 @@
+# Changelog
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](http://keepachangelog.com/).
+Since version 4.0.0, this project adheres to [Semantic Versioning](http://semver.org/).
+
+## [4.0.2] - 2018-06-03
+
+## Fixed
+- Also include `demo.tex` and `CHANGELOG.md` in CTAN upload.
+
+## [4.0.1] - 2018-06-03
+
+### Fixed
+- Fix `\USCCover@setLanguage` to have correct `{}` in the implementation.
+
+### Changed
+- CTAN distributions contains `scientific-thesis-cover.pdf` instead of `README.md` to be consistent with other packages.
+
+## [4.0.0] - 2016-12-30
+
+### Added
+
+- Added shorthand for sec institute.
+- Added `demo.tex` which produces `demo.pdf` providing a short illustration.
+
+### Changed
+
+- Renamed repository from uni-stuttgart-cs-cover to scientific-thesis-cover to stress that the cover also can be used at other institutions.
+- Numbers are now optional.
+- Cover is sans serif again.
+
+### Removed
+
+- Removed `thesis.tex` as we recommend <https://github.com/latextemplates/scientific-thesis-template>.
+- Removed "CR classification" as the [ACM Computing Classification System](https://en.wikipedia.org/wiki/ACM_Computing_Classification_System) from [1998](https://www.acm.org/about-acm/class/how-to-use) is superseeded by a very different system from [2012](https://www.acm.org/publications/class-2012). However, the 2012 classification is not required by the University of Stuttgart anymore.
+
+## [3.1] - 2016-05-29
+
+### Added
+
+- Added README.md
+- Added example thesis
+- Added more types and courses
+- Added support for two-column documents
+
+### Fixed
+
+- Fix typo at German "signature"
+
+### Changed
+
+- Versioning on GitHub
+- Cover is typeset with serif font
+
+## 3.0 - 2012-11-20
+
+Versioned outside of GitHub.
+
+[unreleased]: https://github.com/latextemplates/scientific-thesis-cover/compare/4.0.2...HEAD
+[4.0.2]: https://github.com/latextemplates/scientific-thesis-cover/compare/4.0.1...4.0.2
+[4.0.1]: https://github.com/latextemplates/scientific-thesis-cover/compare/4.0.0...4.0.1
+[4.0.0]: https://github.com/latextemplates/scientific-thesis-cover/compare/3.1...4.0.0
+[3.1]: https://github.com/latextemplates/scientific-thesis-cover/compare/3.0...3.1
diff --git a/Master/texmf-dist/doc/latex/scientific-thesis-cover/README.md b/Master/texmf-dist/doc/latex/scientific-thesis-cover/README.md
index 16081260ac4..e97074c4aa2 100644
--- a/Master/texmf-dist/doc/latex/scientific-thesis-cover/README.md
+++ b/Master/texmf-dist/doc/latex/scientific-thesis-cover/README.md
@@ -1,13 +1,10 @@
-# Cover page for scientific works
-
-[![Build Status](https://circleci.com/gh/latextemplates/scientific-thesis-cover/tree/master.svg?style=shield)](https://circleci.com/gh/latextemplates/scientific-thesis-cover/)
-
+# Cover page for scientific works [![Build Status](https://circleci.com/gh/latextemplates/scientific-thesis-cover/tree/master.svg?style=shield)](https://circleci.com/gh/latextemplates/scientific-thesis-cover/) [![CTAN](https://img.shields.io/badge/CTAN-scientific--thesis--cover-blue.svg?style=flat-square)](https://ctan.org/pkg/scientific-thesis-cover)
Institutions require a cover page and an affirmation at the end of the thesis.
-This work provides both.
+This package provides both.
It stems from the [computer science institutes of the University of Stuttgart], but is open to any university.
-In case you are looking for a **full thesis template** including a cover page and affirmation, please go to <https://github.com/latextemplates/scientific-thesis-template>.
+In case you are looking for a **full thesis template** including a cover page and affirmation, please go to <https://latextemplates.github.io/scientific-thesis-template/>.
Please report issues concerning this package at the GitHub repository at <https://github.com/latextemplates/scientific-thesis-cover>.
## Features
@@ -17,13 +14,16 @@ Please report issues concerning this package at the GitHub repository at <https:
## Installation
-- Download `scientific-thesis-cover.sty`
+Usually, one does not need a seperate installation step, because both MiKTeX and texlive come with a recent version of this template.
+Do not forget to [keep your tex distribution updated](https://tex.stackexchange.com/q/55437/9075).
+
+Alternatively, you can download `scientific-thesis-cover.sty` and put it in the folder where you are going to use it.
## Usage Example
-An example can be found in [tests/TEST_english_oneside.tex](tests/TEST_english_oneside.tex).
+An example can be found in [demo.tex](demo.tex).
-## Usage
+## Usage
Just include the package with all options specified:
@@ -126,16 +126,21 @@ Multiline/Commands in option values are currently only supported if you load `kv
## How to release
+1. Check if indent is correct: `latexindent -y="indentPreamble:1,defaultIndent:' '" -m -w scientific-thesis-cover.sty`
1. Adapt `CHANGELOG.md`
2. Adapt version and date in `scientific-thesis-cover.sty`
3. Tag the release commit using `git tag`
4. Push to GitHub
5. Add CHANGELOG part to GitHub release manually, because [github-release-from-changelog](https://github.com/MoOx/github-release-from-changelog) currently works with `package.json` only.
6. Publish to CTAN
- - Windows: Patch `C:\MiKTeX\scripts\ctanify\ctanify`: Remove `-y` from `zip` command line arguments `zip -q -r -9 -y -m`.
- - Run `pdflatex demo`
- - Run `perl "C:\MiKTeX\scripts\ctanify\ctanify" README.md scientific-thesis-cover.sty demo.pdf`
- - Go to <https://www.ctan.org/upload> and use `scientific-thesis-cover.tar.gz` as archive.
+ - Pre-conditions:
+ - Windows: Patch `C:\MiKTeX\scripts\ctanify\ctanify`: Remove `-y` from `zip` command line arguments `zip -q -r -9 -y -m`.
+ - Windows: Environment variable `TMP` must not contain backslashes. E.g., `C:/TEMP/WIN` is good, `C:\Users\user\AppData\Local\Temp` is bad.
+ - Have `pandoc` and `sed` in the path.
+ - Run `release.bat`.
+ - Go to <https://ctan.org/pkg/scientific-thesis-cover>, choose "Upload"
+ - Use `scientific-thesis-cover.tar.gz` as archive.
+7. Adapt `CHANGELOG.md` to contain `## [unreleased]` again.
## License
diff --git a/Master/texmf-dist/doc/latex/scientific-thesis-cover/demo.tex b/Master/texmf-dist/doc/latex/scientific-thesis-cover/demo.tex
new file mode 100644
index 00000000000..12eefa007e4
--- /dev/null
+++ b/Master/texmf-dist/doc/latex/scientific-thesis-cover/demo.tex
@@ -0,0 +1,19 @@
+\documentclass[oneside]{article}
+\usepackage[utf8]{inputenc}
+\usepackage[
+ title={Super relevant evaluation of new blackhole-generation method},
+ author={Max Musterjunge},
+ type=bachelor,
+ institute=iaas,
+ number=12345,
+ course=se,
+ examiner={Prof.\ Dr.\ Hans Mustermann},
+ supervisor={Otto Normalverbraucher\ M.Sc.},
+ startdate={2012-06-01},
+ enddate={2012-12-01},
+ language=english
+ ]{scientific-thesis-cover}
+\begin{document}
+\Coverpage
+\Affirmation
+\end{document} \ No newline at end of file
diff --git a/Master/texmf-dist/doc/latex/scientific-thesis-cover/scientific-thesis-cover.pdf b/Master/texmf-dist/doc/latex/scientific-thesis-cover/scientific-thesis-cover.pdf
new file mode 100644
index 00000000000..0e32b8f094b
--- /dev/null
+++ b/Master/texmf-dist/doc/latex/scientific-thesis-cover/scientific-thesis-cover.pdf
Binary files differ