README

   1 jalviewTutorial: README
   2 =======================
   3
   4 14th August 2008: J.B. Procter.
   5
   6 This is a refactored version of the Jalview Tutorial for Jalview Version 2.2
   7 which was created by David Martin in 2006.
   8
   9 TheJalviewTutorial.tex is the main tex file.
  10
  11 images/
  12 contain the images included in the tutorial. They are PDFs created
  13 to PDF 1.5 standard (which is higher than the PDF tools available on Kinshar at time of writing).
  14
  15 data/
  16 contains the data used to create the tutorial images and useful data artefacs
  17 that might be provided to user.
  18
  19 Jalview Tutorial.doc is the original word document created by the Jalview 2 team giving the basic outline used to create the tutorial.
  20
  21
  22 Building the document
  23 =====================
  24
  25 The raw output of the tex->PDF conversion should not be checked in, only the final optimised PDF.
  26
  27 1. pdflatex TheJalviewTutorial.tex will (after three passes) generate a properly formatted pdf file TheJalviewTutorial.pdf
  28 Caveats: ensure your pdftools cope with version 1.5 pdf files (latest pdf tools and cygwin tex packages work here).
  29 1.5 run the generated PDF through ps2pdf (ps2pdf TheJalviewTutorial.pdf latest/TheJalviewTutorial.pdf) - reduces size from 47MB to 10MB
  30 2. use acrobat professional to optimise latest/TheJalviewTutorial.pdf
  31  - reduces size from ~11M to about 5M.
  32  - No command line script is available to do this.
  33 3. Save the optimised PDF as latest/TheJalviewTutorial_screen.pdf and check it in when checking in the final tex file used to create it.
  34
  35 Things to check
  36 * images should be high-resolution in the latest/TheJalviewTutorial.pdf, lower resolution in the screen optimised file.
  37 * all special symbols (submenu arrows, etc) should be visible in both versions of the PDF (see 'conventions used in this manual' and 'reordering the alignment' sections for good examples).
  38