Editor's Handbook: Preparing guides for print
The Yucca engine is designed to be adaptable and work on raw Wikitravel content with as little human input as possible. However, printed layout does impose some additional requirements as described below.Image layout
Wikitravel
guides are printed at 300 DPI
and city guidebooks are sized at 4.25"x6.875",
so strict guidelines are imposed on images to ensure legibility and
image
quality. Images consume space both on paper and on disk, and
should be used
sparingly. By default, Yucca ignores any images in the document, unless the additional print attribute is defined:
[[Image:filename|print=X|description]]
Note that pixel specifications, left/right, thumb/frame/noframe and other image attributes are ignored, although the description is preserved by the float and inline types. The following values of "X" are supported:
float
Floating images have a fixed width of 3.25". Width:height ratios may be between 4:3 and 3:2 (which covers the vast majority of consumer digital cameras), as long as the ratio selected is used consistently.
Minimum permissible resolution: 1024x768 (3:4) to 1024x683 (3:2)
Maximum recommended resolution: 2048x1536 (3:4) to 2048x1365 (3:2)
Vertical floated images are not recommended, use fullpage instead. Square images are presently not supported in any meaningful way: fullpage will distort them into rectangles and floated images will grab their own page.
fullpage
Despite the name, a fullpage image is sized only 3.95"x6.875", as 0.3" width must be reserved for the gutter (inner fold). For maps, width:height ratio should be 0.575:1; for photographs, up to 0.666:1 (2:3) is tolerable. Images that do not fit the ratio will be stretched to fit automatically, which reduces quality and may look awkward. Sample sizes:
| Exact
dimensions |
Maximum
allowed
dimensions |
|
| Minimum
permissible resolution |
1185x2062 |
1280x1920 |
| Maximum
recommended resolution |
1730x3008 |
2000x3008 |
If necessary, you can force an image to be rotated by an arbitrary number of degrees by adding the optional argument angle:
[[Image:filename|print=fullpage|angle=-90|description]]
The angle can be any value, positive or negative, although -90 (rotated one quarter clockwise) and 180 (rotated upside down) are probably the most useful options.
See the split command to split an image across two adjacent pages.
NOTE: Use of this tag forces a pagebreak: if placed after a header, the pagebreak goes right before the header, otherwise the break is inserted then and there. For most articles with lead images, this means that fullpage images are best placed after Understand, in the Get in/Get around sections.
- If the image is wide (horizontal), it will be laid out across two columns (width 3.25").
- If the image is tall (vertical), it will be laid out in one column (width 1.5").
Wide (two-column) image: 1024 to 2048 pixels wide
Tall (one-column) image: 450 to 900 pixels wide
Image height is flexible, but the maximum height of an inline image is 5.5", exceeding which will cause the image to be scaled down. Some sample inline image minimum sizes:
| Description |
Type |
Dimensions
(pixels) |
Dimensions
(inches) |
| Half a single column | One column |
450x675 | 1.5"x2.25" |
| One third of a page | Two columns |
1024x577 | 3.25"x1.83" |
| One half of a page | Two columns |
1024x709 | 3.25"x2.25" |
And yes, those are very small -- take care to ensure that the end result is still legible at that size!
Having a lead image is recommended, but not obligatory. Often, though, a single lead image (and maybe a map) suffices to illustrate the chapter.
Takes a large image (must be
precisely 3460x3008) and
splits it into two halves, pasting them on adjacent pages. Handy
for double-page city maps.
Note: Use of this command forces a pagebreak or double pagebreak to ensure that the split image starts on a left page. As the second page of a chapter is always left, placing the image at the end of Understand or Get in usually works nicely.
Note: Use of this command forces a pagebreak or double pagebreak to ensure that the split image starts on a left page. As the second page of a chapter is always left, placing the image at the end of Understand or Get in usually works nicely.
Maps
Transforming a "normal" map into a printable one is probably the most time-consuming part of creating a printable guide.Wikitravel Press strongly recommends using OpenStreetMap for creating maps, see Wikitravel: How to create a map. If you are stuck with a legacy map, you must use the high contrast version of the standard Wikitravel map template. In particular, ensure that you have the Bitstream Vera Sans font installed (it can be downloaded for free from here if you don't have it). For both OSM and handmade maps, any exported files must follow the image size and restrictions above. It is highly recommended, in fact nearly obligatory, that you print out any maps at correct size in order to judge whether they are usable in a guidebook.
Maps should generally be formatted as fullpage images. Very small or highly topical maps should be placed inline instead, with two-page maps can be used with splut.
Tip: when creating maps in Inkscape, note that the height ("H") and ("W") are visible and editable if you have an object selected. Select an appropriate ratio in pixels, do not trust the "DPI" or "inches" values (unless you've calibrated your map accordingly). Instead, after exporting to the correct pixel count, you can use Gimp's "Image > Print Size..." command to set size in inches correctly. (This is not necessary for Yucca, but is handy for your own test prints.)
Special tags
The followed special tags for Yucca use are currently defined.content
PRINT-->
Note: You must use the exact strings "<!--PRINT" and "PRINT-->", no whitespace or lowercase letters allowed.
Any content placed in the <!--PRINT block will not be displayed by the website, but will be imported as is into the printed guide. This is somewhat obsolete now that print=split has been implemented.
{{pagebreak}}
Forces a page break at the current location. Should be used sparingly, ideally not at all.
{{web|...}}
The opposite of PRINT: anything placed in the "web" template is displayed online, but not in printed guides. A typical usage would be to remove references to articles that are not included in the book:
...and that's how you get in. {{web|See the [[Outer Bongoland]] article for further details.}}
This shows up like this online:...and that's how you get in. See the [[Outer Bongoland]] article for further details.but like this printed:
...and that's how you get in.
Quirks
Some of these straddle the line between bugs and features, and could probably be fixed with a suitable application of elbow grease. If one of these is really bugging you, let me know, and I'll see what I can do. See also the Yucca master bug list.Infoboxes
Paragraph breaks are not allowed in infoboxes, use <br><br> instead if you have to. Basic markup is OK, but images and complicated markup will fail randomly.
Listings
All listings must be formatted with listings tags. Each listing has to be in one single line, no carriage returns allowed. Markup within the listing description is OK, but markup in the attributes (address etc) will be ignored or cause random flakiness. (This is not a major problem, as Wikitravel the site doesn't support such markup very well either.) Unknown attributes are ignored with a warning message, while mismatched quotation marks mess up listings very effectively.
Lists
Due to the narrow columns of the printed guide, bulleted lists are flattened out (un-bulleted) automatically. If you absolutely must have a visible list, use a double bullet (**), or a numbered list (#). Triple bullets or higher should be avoided.
Tables
Only limited table support has been implemented. At present, any tables get automatically rotated sideways and packed into one column.