From 0cabfb158111cd4a0c8d430932b47c1384484f23 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Sylvain=20Hall=C3=A9?= Date: Sun, 9 Dec 2018 13:11:39 +0100 Subject: [PATCH] Updated Readme for v2.0 --- Readme.md | 66 ++++++++++++++++++++++++++++++++----------------------- 1 file changed, 38 insertions(+), 28 deletions(-) diff --git a/Readme.md b/Readme.md index 5ac3978..1eb0569 100755 --- a/Readme.md +++ b/Readme.md @@ -51,16 +51,16 @@ does all sorts of nifty things, such as suppressing useless output from LaTeX and colouring (yes, colouring) its meaningful output (errors in red, etc.). -There do exist products, such as [Overleaf](https://www.overleaf.com), -which allow you to instantiate a blank LaTeX paper using many of these -templates. However, there might be various reasons for which you might want -to switch an existing document from one class to the other. For example, you -started writing a paper without deciding where to send it, only to find that -the conference you've chosen has a different publisher than the paper's -current style. Or, a paper sent to a conference (and perhaps rejected) needs -to be sent to another venue with a different publisher. (Note that in the -past, it used to be the *publisher's* job to format your manuscript to their -taste. But that's another story.) +There do exist products, such as [Overleaf](https://www.overleaf.com), which +allow you to instantiate a blank LaTeX paper using many of these templates +(PaperShell can interact nicely with Overleaf; see below). However, there might +be various reasons for which you might want to switch an existing document from +one class to the other. For example, you started writing a paper without +deciding where to send it, only to find that the conference you've chosen has a +different publisher than the paper's current style. Or, a paper sent to a +conference (and perhaps rejected) needs to be sent to another venue with a +different publisher. (Note that in the past, it used to be the *publisher's* job +to format your manuscript to their taste. But that's another story.) Alas, it turns out these stylesheets are not directly interchangeable. Rather than nicely overriding the behaviour of LaTeX's original commands @@ -151,23 +151,13 @@ a separate file called `authors.txt`: `{Marty} {McFly}`. This is used in the EPTCS style for writing abbreviated author names, e.g. "E. Brown, M. McFly, B. Tannen", etc.) -You then call a script named `generate-preamble.php` to generate include -files with the proper syntax for each of the document classes from that -same data. These files are called `preamble-xxxx.inc.tex`, where xxxx is -the document class. +You then call a script named `set-style.php` to generate a preamble and +postamble with the proper syntax for the document classes you want to use. These +files are called `preamble.inc.tex` and `postamble.inc.tex`. -In the main paper file, called `paper.tex`, it suffices to uncomment the -`\input` line for the desired preamble and compile: - - %\input{preamble-ieee-journal.inc.tex} - %\input{preamble-ieee.inc.tex} - %\input{preamble-lncs.inc.tex} - \input{preamble-acm.inc.tex} - ... - -To change the authors or title, modify `authors.txt` and run -`generate-preamble.php` again. To switch between document classes, select -another `\input` line to uncomment and recompile. Voilà! +To change the authors or title, or to switch between document classes, modify +`authors.txt` and run`set-style.php` again. You then just need to recompile. +Voilà! Quick Use --------- @@ -178,9 +168,12 @@ Quick Use 1. Modify `article.txt` with the desired title, authors and institutions. The file is self-documented and tells you how to do it. -2. Call `php generate-preamble.php` to generate the include files, which +2. Call `php set-style.php