docs

ImageN Documentation

This folder provides documentation for the ImageN project.

Jekyell

Jekyll is written in Ruby and managed as a gem, requiring installation of the following environment:

ruby -v
gem -v
gcc -v
g++ -v
make -v

Use gem to install bundler:

gem install bundler

Use bundle to download jekyll (and other gems listed in Gemfile:

bundle

To build and run using the Gemfile environment:

bundle exec jekyll serve

Viewing the result in your browser: http://localhost:4000/:

open http://localhost:4000/

Site Theme

The site uses the Just The Docs theme (MIT License).

The default.html layout has been modified to include copyright.html.

Site Structure

Definition:

• _data
• _includes - reusable page snippets
• _includes/src - source code examples
• _layouts - maps page variables and content to html output
• _sass - reusable css snippets
• assets/css
• assets/images
• assets/js
• _config.yaml Jekyell configuration including global variables
• Gemfile ruby environment definition for bundler
• README.md - readme page for display in GitHub repository

Content:

• index.md - main page
• guide - Programming Guide

Pages

Each page of content starts with a YAML front matter snippet located between two --- lines.

---
layout: default
title: Welcome
nav_order: 5
---

# {{ page.title }}

Visit [Eclipse ImageN](https://projects.eclipse.org/projects/technology.imagen) project
page for more information.

The front matter snippet defines variables used for our page layout, and is followed by Markdown used to define page {{ content }}.

The nav_order is used by the site theme, for details see navigation structure.

Code Examples

Markdown highlighting is used for code snippets:

```java
   // Retrieve and report the mean pixel value.
   double[] mean = (double[])meanImage.getProperty("mean");
   System.out.println("Band 0 mean = " + mean[0]);
```

Complete code examples are placed in _includes/src folder:

```java
{% include src/ImageNSampleProgram.java %}
```