Notice: this Wiki will be going read only early in 2024 and edits will no longer be possible. Please see: https://gitlab.eclipse.org/eclipsefdn/helpdesk/-/wikis/Wiki-shutdown-plan for the plan.
Difference between revisions of "Scout/Book/3.9"
(→The Eclipse Scout Book) |
(→Download of Current Status) |
||
| Line 10: | Line 10: | ||
== Download of Current Status == | == Download of Current Status == | ||
| − | There is also a continuous integration environment that is building the book on a regular basis. To check for the current state of the book you may visit [http://tools.bsiag.com/scoutbook/ tools.bsiag.com/scoutbook/] | + | There is also a continuous integration environment setup at [http://www.bsiag.com/eclipse BSI] that is building the book on a regular basis. To check for the current state of the book you may visit [http://tools.bsiag.com/scoutbook/ tools.bsiag.com/scoutbook/] |
Each build will create a directory with the following structure | Each build will create a directory with the following structure | ||
Revision as of 18:26, 8 November 2012
The Scout documentation has been moved to https://eclipsescout.github.io/.
Contents
The Eclipse Scout Book
The Eclipse Scout Book is the attempt to significantly improve the state of the documentation of the Eclipse Scout framework.
The goal of this effort is to have written a substantial part of the book by Kepler release date (June 2013 - the content of the book will target Scout 3.9)
To allow for participation by the community the book will be written in the open from it's very first version (as of now (November 8th 2012) there is hardly more than the proposed table of contents with some pointers to existing forum entries.
Download of Current Status
There is also a continuous integration environment setup at BSI that is building the book on a regular basis. To check for the current state of the book you may visit tools.bsiag.com/scoutbook/
Each build will create a directory with the following structure
yyyy-mm-dd_hh_MM-SS
epub
book.epub
html
book.zip (all files in a single zip)
book.html (main html file for online browsing)
... many more files
pdf
book.pdf
Repository
The current repository is located at the following github repository. It will be replaced by a more prominent location soon.
Contributing
Steps for contributing
To be able to contribute to the Scout book, please
- create a github account by
- browsing to "github.com"
- signing up (you may sign up for a free account) (samuelrenold)
- install git on your local computer by
- downloading the latest version of git
- installing git using the standard options in all installation steps
- clone the github account of matthiaszimmermann by
- opening the Git Gui and using the link clone project archive
- entering the github repository into the textfield origin
Steps for building the book locally
This section holds the necessary installation/setup that is required to build the book out of the sources.
Most probably, you may want to build the book on your own computer to check your contribution prior to publish them. If so, you need to download and install
- 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 sure to edit the makefile in the root path of the git repository to account for the installation paths of the downloaded software):
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
Installing the software
Windows
For Windows, please follow the steps indicated below:
- Download and install LaTeX
- visit (basic-miktex-2.9.4521-x64)
- download the installer file
- execute the installer file and take note of the installation path (you will later need to adapt the makefile)
- Download and install Calibre
- visit (calibre version 0.9.5)
- download the installer file
- execute the installer file and take note of the installation path (you will later need to adapt the makefile)
- Download and install make
- visit (GNU Make 3.82)
- download the executable and put it into a folder of your preferences
- Download and install 7-Zip
- visit (7-Zip)
- download the installer file
- execute the installer file and take note of the installation path (you will later need to adapt the makefile)