Notice: This Wiki is now read only and edits are no longer possible. Please see: https://gitlab.eclipse.org/eclipsefdn/helpdesk/-/wikis/Wiki-shutdown-plan for the plan.
Difference between revisions of "Scout/Book/3.9"
(→Windows) |
|||
| Line 8: | Line 8: | ||
* HTML | * HTML | ||
* EPUB | * EPUB | ||
| + | |||
| + | == Repository == | ||
| + | |||
| + | The current repository is located at the address given below. | ||
| + | |||
| + | [https://github.com/matthiaszimmermann/scoutbook github repository for book contents] | ||
| + | |||
| + | It will be replaced by a more prominent location soon. | ||
== Setup for Contributing == | == Setup for Contributing == | ||
| Line 21: | Line 29: | ||
In the sections below, necessary download and installation steps of a working setup are described for Windows (if you have a working setup for Mac or Linux, please consider to amend a corresponding section. | In the sections below, necessary download and installation steps of a working setup are described for Windows (if you have a working setup for Mac or Linux, please consider to amend a corresponding section. | ||
| + | |||
| + | Building the book is done using ''make'' in the main folder of your local book repository: | ||
| + | |||
| + | make clean | ||
| + | make pdf | ||
| + | make html | ||
| + | make epub | ||
| + | |||
| + | The output will then be moved to the following locations | ||
| + | |||
| + | out\pdf\book.pdf | ||
| + | out\html\book.zip (containing the html and other necessary files) | ||
| + | out\epub\book.epub | ||
| + | |||
| + | Depending on your installation you will need to update the paths in your [https://github.com/matthiaszimmermann/scoutbook/blob/master/makefile makefile] to the executable files | ||
=== Windows === | === Windows === | ||
Revision as of 09:22, 5 November 2012
The Eclipse Scout Book
Some background
Download
- HTML
- EPUB
Repository
The current repository is located at the address given below.
github repository for book contents
It will be replaced by a more prominent location soon.
Setup for Contributing
This section holds the necessary installation/setup that is required to build the book out of the sources.
- latex (for PDF and HTML version)
- calibre (for creation and viewing of EPUB version)
- make (for building the book using a make file)
- zip/unzip (for packaging of the HTML version into a single zip file)
For building the book and generating the output files a continuous integration environment will be set up, making it possible to contribute to the Scout book without having a local working latex installation.
In the sections below, necessary download and installation steps of a working setup are described for Windows (if you have a working setup for Mac or Linux, please consider to amend a corresponding section.
Building the book is done using make in the main folder of your local book repository:
make clean make pdf make html make epub
The output will then be moved to the following locations
out\pdf\book.pdf out\html\book.zip (containing the html and other necessary files) out\epub\book.epub
Depending on your installation you will need to update the paths in your makefile to the executable files
Windows
Installation directories correspond to paths in makefile
- Latex download (basic-miktex-2.9.4521-x64)
- Install directory c:\latex\MiKTeX 2.9
- Calibre download (calibre version 0.9.5)
- Install directory C:\latex\Calibre2
- Make download (GNU Make 3.82)
- Install directory C:\latex\make
- Zip/unzipdownload (7-Zip)
- Install directory c:\Program Files\7-Zip