Forum: Ruby minicomic 0.0.1

Announcement (2017-05-07): www.ruby-forum.com is now read-only since I unfortunately do not have the time to support and maintain the forum any more. Please see rubyonrails.org/community and ruby-lang.org/en/community for other Rails- und Ruby-related community platforms.
912c61d9da47754de7039f4271334a9f?d=identicon&s=25 MenTaLguY (Guest)
on 2007-03-29 10:59
(Received via mailing list)
= minicomic 0.0.1

+minicomic+ is a library providing a set of rake rules for building
print and web-ready files for minicomics from a set of SVG files.

Currently, it is hard-coded for generating 5.5x8.5in format
black-and-white comics of the sort most suitable for inexpensive
photocopying.

== getting minicomic

+minicomic+ is available from Rubyforge:

 http://www.rubyforge.org/projects/minicomic

Or via RubyGems:

 sudo gem install minicomic

Development versions are available via git from repo.or.cz:

 git://repo.or.cz/minicomic.git
 http://repo.or.cz/r/minicomic.git

== requirements

In addition to the obvious requirements for Ruby and Rake, +minicomic+
requires the following software to be installed and available on your
shell's path:

* Inkscape
* psutils
* Ghostscript
* ImageMagick
* pngcrush

If you're on Ubuntu, these correspond to the +inkscape+, +psutils+,
<tt>gs-gpl</tt>, +imagemagick+ and +pngcrush+ packages, respectively.

== usage

The simplest way to use +minicomic+ is to create a +Rakefile+ as
follows:

  require 'minicomic'

  minicomic '.'

+minicomic+ will look for pages in a <tt>pages/</tt> folder in the given
directory (in this particular case, '.' meaning the directory where the
+Rakefile+ lives).

+minicomic+ looks for SVG files in <tt>pages/</tt> named according to
the following conventions:

<tt>page-NN.svg</tt>:: page +NN+
<tt>front-cover.svg</tt>:: the front cover of the comic (optional)
<tt>back-cover.svg</tt>:: the back cover of the comic (optional)
<tt>inside-front.svg</tt>:: the inside front cover of the comic
(optional)
<tt>inside-back.svg</tt>:: the inside back cover of the comic (optional)

It is also possible to have two-page spreads in single files:

<tt>pages-NN-MM.svg</tt>:: the spread spanning pages
<tt>NN</tt>-<tt>MM</tt>
<tt>cover.svg</tt>:: the cover (back and front together in one file;
optional)

Page numbers start at 1 (page 1 is a right-handed page, and the first
interior page).  Page documents should be 5.5x8.5in or smaller for
single pages, and 11x8.5in for two-page spreads.

== print output

When generating output for print, +minicomic+ will round the number of
interior pages up to the next multiple of four, padding with blank pages
as needed.  The page graphics will be scaled down slightly from their
full size, and smaller graphics will be centered.

To generate a "proof" PDF that you can examine to see what spreads will
look like in the assembled comic, use:

 rake proof

The PDF will be created as <tt>print/proof.pdf</tt>.  Since I rarely use
the inside covers for anything, +minicomic+ places the front and back
covers opposite the first and last interior pages respectively.

To generate a set of PDFs suitable for printing and assembly, use:

 rake print

This will generate a set of three PDFs:

<tt>print/duplex.pdf</tt>:: suitable for duplex printing
<tt>print/front.pdf</tt> and <tt>print/back.pdf</tt>:: front and back
sides for single-sided printing

If you are using a duplex printer, if you're lucky it will deposit its
output pages face-up and they will be ready for assembly (this is the
norm).  Otherwise if it deposits its pages face-down, you will have
reverse them before you can assemble the comic.

When using the single-sided PDFs, _you will need to experiment_ to find
the correct order to use them in, and the correct way to flip the paper.
For my printer, I print <tt>back.pdf</tt> first, then flip the stack the
long way before printing <tt>front.pdf</tt> on it.  Other printers will
differ depending on how the paper is loaded in the tray, and how it is
stacked on output.

== web output

You can generate files for web upload via:

 rake web

When generating output for the web, +minicomic+ will generate a set of
4-bit greyscale PNGs, and a corresponding set of JPEG thumbnails:

<tt>web/page-NN.png</tt>:: page +NN+
<tt>web/thumbnail-NN.jpeg</tt>:: thumbnail of page +NN+

== cleanup

You can easily get rid of the temporary and output files with:

 rake clean
This topic is locked and can not be replied to.