Metadata

About

This is a collection of tools for working with SVG images. There isn’t much in it at the moment but it will likely grow over time. I’ll likely update svg2ggr when I have some time and add it to this package.

FAQ

# Requires poppler
# Concatenates files. Fast! Output size is approximately the sum of the
# input size. No perceptible changes.
pdfunite *.pdf out.pdf

# Requires pdfjam (texlive-core)
# Concatenates files. Output size is approximately the sum of the input
# size. No perceptible changes.
pdfjoin -o out.pdf *.pdf

# Requires ghostscript
# "Prints" files. Output is smaller than the input size but some changes may
# be perceptible. Sometimes it completely mangles objects. Try different
# ghostscript options.
gs -dBATCH -dNOPAUSE -q -sDEVICE=pdfwrite -sOutputFile=out.pdf *.pdf

# Requires imagemagick.
# Huge output files. Slow. Not sure how the files are joined.
convert *.pdf out.pdf

Help Message (svg-img_mgr)

$ svg-img_mgr --help

usage: SvgImgMgr.py [-h] [-v] [--debug]
                    {list,ls,extract,ex,embed,em,rename,mv,dedupe,dd,scrub,sc,inkscape,ink,jessyink,ji}
                    ...

Manage images within an SVG file.

positional arguments:
  {list,ls,extract,ex,embed,em,rename,mv,dedupe,dd,scrub,sc,inkscape,ink,jessyink,ji}
                        sub-command help
    list (ls)           list svg data
    extract (ex)        Collect linked and/or embedded images.
    embed (em)          Embed linked data (usually images) with base64-encoded
                        data URIs.
    rename (mv)         rename linked data (usually images)
    dedupe (dd)         deduplicae linked and embedded images
    scrub (sc)          remove unnecessary elements
    inkscape (ink)      Inkscape commands
    jessyink (ji)       JessyInk commands

options:
  -h, --help            show this help message and exit
  -v, --verbose         Increase verbosity.
  --debug               Enable debugging messages.

Help Message (svg-img_mgr list)

$ svg-img_mgr list --help

usage: SvgImgMgr.py list [-h] [-i] [--ids] [--hidden] svg

positional arguments:
  svg           The SVG file.

options:
  -h, --help    show this help message and exit
  -i, --images  List images.
  --ids         List id attributes (sometimes useful for debugging).
  --hidden      List hidden elements.

Help Message (svg-img_mgr extract)

$ svg-img_mgr extract --help

usage: SvgImgMgr.py extract [-h] [-u <path>] [-e] [-l] svg outdir

collect linked and/or embedded images

positional arguments:
  svg                   The SVG file.
  outdir                Collect files in this directory.

options:
  -h, --help            show this help message and exit
  -u <path>, --update <path>
                        Generate a new SVG image with updated links here.
  -e, --embedded        Extract embedded data.
  -l, --linked          Extract linked data.

Help Message (svg-img_mgr embed)

$ svg-img_mgr embed --help

usage: SvgImgMgr.py embed [-h] svg outpath

embed linked data

positional arguments:
  svg         The SVG file.
  outpath     The path to the new SVG file.

options:
  -h, --help  show this help message and exit

Help Message (svg-img_mgr rename)

$ svg-img_mgr rename --help

usage: SvgImgMgr.py rename [-h] [-p <oldpath> <newpath>] [-c <path>] svg

rename linked data

positional arguments:
  svg                   The SVG file.

options:
  -h, --help            show this help message and exit
  -p <oldpath> <newpath>, --pair <oldpath> <newpath>
                        Old and new path of file to rename.
  -c <path>, --copy <path>
                        Copy files instead of moving them. The new SVG file
                        will be saved to <path>.

Help Message (svg-img_mgr dedupe)

$ svg-img_mgr dedupe --help

usage: SvgImgMgr.py dedupe [-h] svg

deduplicate images

positional arguments:
  svg         The SVG file.

options:
  -h, --help  show this help message and exit

Help Message (svg-img_mgr scrub)

$ svg-img_mgr scrub --help

usage: SvgImgMgr.py scrub [-h] [-o <path>] [-l] [-a] [--sodipodi] [--defs] svg

remove unnecessary elements

positional arguments:
  svg                   The SVG file.

options:
  -h, --help            show this help message and exit
  -o <path>, --output <path>
                        Save the updated file here. Without this option, the
                        original will be overwritten.
  -l, --list            List changes that would be made.
  -a, --all             Remove all unnecessary elements.
  --sodipodi            Remove sodipodi:absref tags.
  --defs                Remove unused definitions.

Help Message (svg-img_mgr jessyink)

$ svg-img_mgr jessyink --help

usage: SvgImgMgr.py jessyink [-h]
                             {list,ls,renumber,rn,autotext,at,export,ex,clear,cl}
                             ...

JessyInk commands

positional arguments:
  {list,ls,renumber,rn,autotext,at,export,ex,clear,cl}
                        sub-command help
    list (ls)           list JessyInk slides
    renumber (rn)       renumber JessyInk effects to fill numbering gaps
    autotext (at)       set and unset JessyInk autotexts
    export (ex)         export JessInk slides
    clear (cl)          clear JessyInk effects

options:
  -h, --help            show this help message and exit

Help Message (svg-img_mgr jessyink list)

$ svg-img_mgr jessyink list --help

usage: SvgImgMgr.py jessyink list [-h] [-c] [-t] svg

list JessyInk slides

positional arguments:
  svg          The SVG file.

options:
  -h, --help   show this help message and exit
  -c, --count  Count the number of effects per slide.
  -t, --title  Include the slide title in the output.

Help Message (svg-img_mgr jessyink renumber)

$ svg-img_mgr jessyink renumber --help

usage: SvgImgMgr.py jessyink renumber [-h] [-l] [-o <path>] svg

renumber JessyInk effects

positional arguments:
  svg                   The SVG file.

options:
  -h, --help            show this help message and exit
  -l, --list            List changes that would be made.
  -o <path>, --output <path>
                        Save the updated file here. Without this option, the
                        original will be overwritten.

Help Message (svg-img_mgr jessyink autotext)

$ svg-img_mgr jessyink autotext --help

usage: SvgImgMgr.py jessyink autotext [-h] [-l]
                                      [-t {slideTitle,slideNumber,numberOfSlides}]
                                      [--by {id,text}] [-r] [-o <path>]
                                      svg [args ...]

set and unset JessyInk autotexts

positional arguments:
  svg                   The SVG file.
  args                  The elements to which to apply the changes.

options:
  -h, --help            show this help message and exit
  -l, --list            List autotexts.
  -t {slideTitle,slideNumber,numberOfSlides}, --type {slideTitle,slideNumber,numberOfSlides}
                        Select the type of autotext to set. If this option is
                        not given, autotext will be unset on the selected
                        targets, or all if no targets are given.
  --by {id,text}        Criterion for setting autotexts. id: element id
                        attribute, text: content of text element Default: text
  -r, --remove          Remove autotexts on the selected elements, or all if
                        no arguments are given.
  -o <path>, --output <path>
                        Save the updated file here. Without this option, the
                        original will be overwritten.

Help Message (svg-img_mgr jessyink export)

$ svg-img_mgr jessyink export --help

usage: SvgImgMgr.py jessyink export [-h] [-s SLIDES [SLIDES ...]] [--simplify]
                                    svg outdir

export JessyInk slides

positional arguments:
  svg                   The SVG file.
  outdir                The output directory.

options:
  -h, --help            show this help message and exit
  -s SLIDES [SLIDES ...], --slides SLIDES [SLIDES ...]
                        Select slides to export, For example export the first
                        5 slides with all effects with "-s 1 2 3 4 5", or in
                        Bash use "-s {1..5}". To select a slide and an effect,
                        use "/". For example, the first 3 effects of the 8th
                        slide: "-s 8/0 8/1 8/2" or "-s 8/{0..2}" (effects are
                        numbered from 0). Negative numbers will be counted
                        from the end. To export just the final effect of each
                        slide, use "-s /-1".'
  --simplify            Remove unnecessary elements from each slide to reduce
                        its size.

Help Message (svg-img_mgr jessyink clear)

$ svg-img_mgr jessyink clear --help

usage: SvgImgMgr.py jessyink clear [-h] [--layers <number> [<number> ...]]
                                   [--nested] [-o <path>]
                                   svg

clear JessyInk effects

positional arguments:
  svg                   The SVG file.

options:
  -h, --help            show this help message and exit
  --layers <number> [<number> ...]
                        The layers on which to clear effects.
  --nested              Only clear nested effects.
  -o <path>, --output <path>
                        Save the updated file here. Without this option, the
                        original will be overwritten.

Help Message (svg-img_mgr inkscape)

$ svg-img_mgr inkscape --help

usage: SvgImgMgr.py inkscape [-h] {dedupemarkers,dm} ...

Inkscape commands

positional arguments:
  {dedupemarkers,dm}  sub-command help
    dedupemarkers (dm)
                      deduplicate Inkscape stock markers

options:
  -h, --help          show this help message and exit

Help Message (svg-img_mgr inkscape dedupemarkers)

$ svg-img_mgr inkscape dedupemarkers --help

usage: SvgImgMgr.py inkscape dedupemarkers [-h] [-o <path>] [-l] [-d] svg

deduplicate Inkscape stock markers

positional arguments:
  svg                   The SVG file.

options:
  -h, --help            show this help message and exit
  -o <path>, --output <path>
                        Save the updated file here. Without this option, the
                        original will be overwritten.
  -l, --list            List changes that would be made.
  -d, --delete          Delete unused markers.

Help Message (jessyink_to_slides)

$ jessyink_to_slides -h

NOTE
  This script should probably be replaced by ji2pdf. The only advantage of this
  script is that it uses the embedded JessyInk javascript so it will render
  correctly even if JessyInk changes, but ji2pdf will be updated in that case.

USAGE
  jessyink_to_slides [-h] [-r <range>] [-o <path>] <svg file>

DESCRIPTION
  Use PhantomJS and Inkscape to export slides from a JessyInk SVG file directly
  from the command line.

HOW IT WORKS

  1. Collect the SVG file and all linked and embedded images in a temporary
     directory using svg-img_mgr. This ensures that all relative paths work
     in the intermediate files and it also deduplicates data.
  2. Use phantomjs and custom javascript to select a slide and export the
     modified DOM as an SVG image.
  3. Extract the exported slide with inkscape and save it in the chosen format.
  4. Goto 2 until the full range has been exported.

OPTIONS
  -h
    Show this message and exit.

  -r <range>
    Select the slides to export as a range, e.g "-r 4-10" will extract slides 4
    to 10, inclusive. If the start slide is omitted, e.g. "-10", it will default
    to 1. The end slide is required because this script does not autodetect the
    number of slides. If a single number is given then it will be interpretted
    as the end slide. Obviously the start must be equal to or less than the end.

  -o <path>
    The output path template. The extension will be stripped of an used to set
    the output format. Valid extensions are pdf, png, svg, eps, ps, emw, and
    wmf. Inkscape will be used to export the slide. The slide number will be
    inserted before the extension in <path> and the output will be saved there.

    Default: "jessyink/slide_.pdf"

CHANGELOG

TODO