Skip to main content

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.

Jump to: navigation, search

Scout/Book/3.9

< Scout‎ | Book
Revision as of 09:23, 5 November 2012 by Unnamed Poltroon (Talk) (Repository)

The Eclipse Scout Book

Some background

Download

  • PDF
  • HTML
  • EPUB

Repository

The current repository is located at the following github repository. 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

  • Zip/unzipdownload (7-Zip)
  • Install directory c:\Program Files\7-Zip

Back to the top