summaryrefslogtreecommitdiff
path: root/2005/flow-accounting-lt2005/ltpdk/README
diff options
context:
space:
mode:
authorHarald Welte <laforge@gnumonks.org>2015-10-25 21:00:20 +0100
committerHarald Welte <laforge@gnumonks.org>2015-10-25 21:00:20 +0100
commitfca59bea770346cf1c1f9b0e00cb48a61b44a8f3 (patch)
treea2011270df48d3501892ac1a56015c8be57e8a7d /2005/flow-accounting-lt2005/ltpdk/README
import of old now defunct presentation slides svn repo
Diffstat (limited to '2005/flow-accounting-lt2005/ltpdk/README')
-rw-r--r--2005/flow-accounting-lt2005/ltpdk/README178
1 files changed, 178 insertions, 0 deletions
diff --git a/2005/flow-accounting-lt2005/ltpdk/README b/2005/flow-accounting-lt2005/ltpdk/README
new file mode 100644
index 0000000..1a7791a
--- /dev/null
+++ b/2005/flow-accounting-lt2005/ltpdk/README
@@ -0,0 +1,178 @@
+LinuxTag 2003 Paper Development Kit HOWTO
+=========================================
+
+The ltpdk (LinuxTag Paper Development Kit) is a self-contained
+collection of tools, examples, and documentation about how to write and
+submit papers in the LinuxTag flavour of DocBook. Included in this
+package are:
+
+ - statically linked xmllint and xsltproc executables to check your
+ paper against the DocBook DTD and to convert it to HTML for easy
+ viewing. There are also convenient wrappers for those tools in the
+ "bin" directory.
+
+ - The DocBook Simplified DTD and the LinuxTag-Metatron
+ DocBook-to-HTML stylesheet for use with xmllint and xsltproc. These
+ files describe the internal structure of valid XML documents. Usually
+ you don't need to look at these files in the "xml" directory.
+
+ - The sources for xmllint and xsltproc in the "src" directory. There is
+ no need to look at these files either if you just want to write a
+ paper. However, as the ltpdk is Free Software, we provide the
+ source code.
+
+ - You can find an example of using DocBook for a LinuxTag 2003 paper
+ in the "example" directory. Most of it is fairly self-explanatory.
+
+ - We already prepared the dirctory "paper" for your paper and placed
+ an empty template in it. This is a good starting point for your
+ document.
+
+
+0. For the experienced and impatient
+------------------------------------
+
+Enter your paper in the template in paper/paper-999-de.xml and rename it
+with your talk number.
+
+Read the example in example/paper.xml.
+
+Check if your paper is valid with bin/lt-validate or generate preliminary
+HTML with bin/lt-convert.
+
+Create a tar-file with bin/lt-pack and upload the result to the CC.
+
+
+1. Prerequistes
+---------------
+
+You need just a Linux system and the LinuxTag Paper Development Kit
+(ltpdk) which can be downloaded from
+
+ http://www.linuxtag.org/cfp/ltpdk.tar.gz
+
+The ltpdk extracts to a self-contained directory and once extracted
+depends on no special software (except a shell and the commands sed, pwd
+and tar):
+
+ $ cd /wherever/you/want
+ $ wget http://www.linuxtag.org/cfp/ltpdk.tar.gz
+ $ tar xfvz ltpdk.tar.gz
+ $ cd ltpdk
+
+If you want also the sources, you can download ltpdk-src.tar.gz instead.
+
+
+2. Name conventions for your paper
+----------------------------------
+
+There is a directory "paper" prepared with a minimal template for
+you. Please change to that directory and rename the template according
+to your paper number. You can find your paper number in your
+confirmation message or when you log into the CC ("EDIT PAPER").
+Assuming your paper number is 789, please rename the template to:
+
+ $ cd paper
+ $ ls
+ paper-999.xml
+ $ mv paper-999.xml paper-789-en.xml
+or
+ $ mv paper-999.xml paper-789-de.xml
+
+respectively according to the language you are using. Please pad the
+paper number with zeros to three digits, if necessary (e. g. "046").
+
+Now you can edit your document with any editor you like or import the
+content from an other location in this file. Should you want to include
+pictures or figures in your paper, copy all necessary files in the same
+directory as the paper itself and keep the following name scheme:
+
+ picture-789-01.gif
+ picture-789-02.jpg
+ picture-789-03.png
+ ...
+
+and so on. Please use GIF or JPG format images when providing images.
+We're aware of the fact that GIF ist not patent free, but real life
+proved that PNG is not an alternative in all circumstances.
+
+If you have additional material for inclusion on the CDROM
+or for the website, you place these files in the subdirectory
+"contrib". If you have only PDF-material (which is not our primary
+choice to a full paper), please also drop it here.
+
+
+3. How to use DocBook
+---------------------
+
+DocBook is an XML-based markup language slightly similiar in use like
+HTML. DocBook has a lot of features, which can be complex and
+confusing at first sight. We advise you to use only a recommended
+subset that is described in a separate document along with links for
+more tutorials, if you wish to learn more about DocBook.
+
+We provide an example that illustrates the use of all the
+recommended markup tags in "example-en.xml".
+
+If you are already familiar with DocBook, you can use all features of
+the DTD although we strongly recommend to keep to the defined subset
+of tabs and containers. Your root container has to be <article>.
+
+
+4. Validating your Paper
+------------------------
+
+There are three alternatives to check if your paper conforms to the
+XML/DocBook requirements. Papers conforming to these standards reduce
+immensely the efforts to integrate your submission in the conference
+proceedings.
+
+To check if your paper conforms to the XML syntax, execute
+
+ $ ./bin/lt-validate paper-789-xx.xml
+
+If your paper contains no errors, the wrapper will just print it to
+stdout, nicely indented. Otherwise, you will get a declarative error
+message on what's wrong.
+
+For easier viewing, you can convert your paper to a HTML fragment that
+can be viewed with your favourite browser. The converting will NOT
+produce a valid HTML document for technical reasons (the provided
+Docbook-to-HTML stylesheet is only one part of our rendering pipeline
+in the publishing framework). However that should be no problem with
+the common browsers. To create HTML for proofreading, use
+
+ $ ./bin/lt-convert paper-789-xx.xml > paper.html
+
+The third option is to package your paper and upload it to the
+Conference Center (see next section).
+
+
+5. Packaging and Uploading
+--------------------------
+
+Change to the main directory of the ltpdk and put you files in an
+archive:
+
+ $ cd ..
+ $ ls
+ bin COPYING example-en.xml example.gif example.html HOWTO
+ paper README src xml
+ $ ./bin/lt-package
+
+This creates the file "paper.tar.gz". Now open a web browser to
+
+ https://www.linuxtag.org/cfp/login
+
+log in with your username and password, click on the "[edit]" button
+trailing your abstract and upload the paper.tar.gz file to the CC.
+
+We are still working on a preview mode accessible directly from the CC.
+There should appear ne new link ("preview paper") in the near future.
+
+
+6. Questions
+------------
+
+If you have questions you may ask our DocBook team leader Michael
+Kleinhenz (kleinhenz@linuxtag.org) or Nils Magnus (magnus@linuxtag.org).
personal git repositories of Harald Welte. Your mileage may vary