diff options
| -rw-r--r-- | Makefile | 4 | ||||
| -rw-r--r-- | guide/hello.adoc | 4 | ||||
| -rw-r--r-- | guide/intro.adoc | 57 | ||||
| -rw-r--r-- | guide/theming.adoc | 42 |
4 files changed, 105 insertions, 2 deletions
@@ -12,6 +12,8 @@ RUBY?= ruby SECTIONS= # defined SECTIONS+= guide/hello.adoc +SECTIONS+= guide/intro.adoc +SECTIONS+= guide/theming.adoc ########## ########## ########## @@ -28,7 +30,7 @@ guide.pdf: Gemfile.lock total.adoc CLEANFILES+= total.adoc total.adoc: ${SECTIONS} - echo > ${.TARGET} + printf "// AUTOMATICALLY GENERATED ON $$(date)\n\n" > ${.TARGET} .for section in ${SECTIONS} cat ${section} >> ${.TARGET} echo >> ${.TARGET} diff --git a/guide/hello.adoc b/guide/hello.adoc index bd31de7..5ae6234 100644 --- a/guide/hello.adoc +++ b/guide/hello.adoc @@ -1,6 +1,8 @@ = Willora Guide +Charlotte Koch +:toc: -== Introduction +== Lorem Ipsum Amet eos repellendus quasi nesciunt magnam temporibus hic. Voluptatibus dolorem et ut optio rerum facilis quos. Inventore modi asperiores diff --git a/guide/intro.adoc b/guide/intro.adoc new file mode 100644 index 0000000..c2230ed --- /dev/null +++ b/guide/intro.adoc @@ -0,0 +1,57 @@ +== Introduction + +**Willora** is a software tool designed for simple prepress tasks. + +It is designed to enable small publishers and self publishers to generate +good-looking books for print and digital publication. Willora was built to +lower the barrier to entry for indie presses by striking a balance between +ease of use, sensible defaults and + +Under the hood, Willora uses AsciiDoc markup and the Asciidoctor suite to +generate PDFs and EPUBs. + + +=== Use Cases + +Willora is optimized for prose works of fiction with black-and-white +interior design and few graphics (if any). In short, it's built for novels +(and perhaps technical documentation). + + +=== Motivation + +When it comes to design and layout of a book's interior, aspiring +self-publishers are often told to just use Adobe InDesign. Don't think about +it -- just use the same tool that everyone else is using and don't question +it. + +I've never been satisfied with this answer. + +InDesign is a complex application that can handle + +In my opinion, Adobe InDesign is overkill (and overly expensive) for the +prepress tasks that a starting author would most likely need for their +novel. + + + +=== System Requirements + +Willora is designed to be very portable. It should work well on Windows and +Unix-like operating systems, but the Willora developers officially support +the following: + +- Windows +- macOS +- Linux +- NetBSD + +In general, if it's a system that can run all of these dependencies, then it +should be able to support Willora, too. + +- BSD make(1) +- Ruby 3.2 or higher +- Bundler +- Pandoc +- GraphicsMagick +- Ghostscript diff --git a/guide/theming.adoc b/guide/theming.adoc new file mode 100644 index 0000000..c8054d1 --- /dev/null +++ b/guide/theming.adoc @@ -0,0 +1,42 @@ +== Theming + +The Willora system separates the content (the actual copy of your +manuscript) from its presentation (how it looks). + +Willora comes with a collection of premade themes that you can try out. + +If you're interested, you can consult Asciidoctor's own documentation about +theming PDFs. There is a lot of good information in there. + + +=== Limitations of Asciidoctor's Theming Engines + +However, the reality is more complicated. The key thing to understand is +that Asciidoctor's PDF theming engine does not actually control every aspect +of the design and layout of a book's pages. Furthermore, the PDF theming +engine enter the picture __at all__ when generating EPUBs. This poses a +problem because one of Willora's goals is to make PDF and EPUB output look +similar to each other. + +This is why Willora has developed tools to unify the experience. + + +=== Willora's Theming Principles + +Willora's theming engine is designed around the following assumptions: + +- The interior of the book is entirely in grayscale. + +- The publisher does not want to deviate too much from the expected elements + of a professionally typset novel: a typical page has page numbers, the + author's name and/or the book's title in the header. + +- The frontmatter and backmatter of a book is almost certainly formatted + differently from the main text. + +- The __only__ difference between a PDF for prepress (to be sent to the + printer) and a "`display`" PDF (to be viewed on a screen) is that the + former has extra bleed space. + +- The publisher desires to make the ebook capture the spirit of the print + edition in look and feel. |