[manual] Added a manual section

Author: pkriens

.project

@@ -1,6 +1,6 @@
 <?xml version="1.0" encoding="UTF-8"?>
 <projectDescription>
-	<name>docs</name>
+	<name>bndtools.github.io</name>
 	<comment></comment>
 	<projects>
 	</projects>

Gemfile

@@ -1,4 +1,3 @@
 source 'https://rubygems.org'
-
-gem 'github-pages'
+gem 'github-pages', group: :jekyll_plugins
 gem 'jekyll-seo-tag'

_config.yml

@@ -5,7 +5,7 @@ plugins:
 markdown: kramdown
 
 collections:
-  chapters:
+  manual:
     output: true
 
 defaults:

_includes/sidebar.htm

@@ -8,6 +8,16 @@
 <li><a href="/concepts.html">Workspace Concepts</a></li>
 <li><a href="/installation.html">Installation</a></li>
 <li><a href="/tutorial.html">Tutorials</a></li>
+<li><a href="/manual/about.html">Bndtools Reference</a>
+    {% if page.url contains '/manual' %}
+    <ul>
+        <li><a href="/manual/packageexplorer.html">Package Explorer</a>
+        <li><a href="/manual/repositories-view.html">Repositories View</a>
+        <li><a href="/manual/resolution-view.html">Resolution View</a>
+        <li><a href="/manual/bndeditor.html">The bnd Editor</a>
+        <li><a href="/manual/jareditor.html">The JAR Viewer</a>
+    </ul>
+    {% endif %}
 <li><a class="external-left" href="http://bnd.bndtools.org">bnd manual</a></li>
 <li><a href="/faq.html">FAQ</a></li>
 

_manual/about.md

@@ -0,0 +1,25 @@
+---
+title: Introduction
+description: An overview of the Bndtools manual
+---
+
+Bndtools is an Eclipse Plugin based on [bnd][1] with the goal to make programming for OSGi easier than in 
+any other environment. Correction, to make programming in Java easier than any other environment!
+
+As a plugin Bndtools hooks into the IDE in numerous places. Clearly, Eclipse already provides a very comprehensive
+Java programming environment and Bndtools leverages this to the hilt. 
+
+The following image provides an overview of the most important views in the Bndtools plugin. You can click on the
+view and it should take you to the appropriate place.   
+
+<!-- Image Map Generated by http://www.image-map.net/ -->
+<img src="https://user-images.githubusercontent.com/200494/44413668-38a21f00-a56c-11e8-8356-157c307ea4ac.png" usemap="#image-map" style="width:1000px">
+
+<map name="image-map">
+    <area target="_self" alt="Package Explorer" title="Package Explorer" href="/manual/packageexplorer.html" coords="0,55,250,408" shape="rect">
+    <area target="_self" alt="Bnd Editor" title="Bnd Editor" href="/manual/bndeditor.html" coords="250,56,808,455" shape="rect">
+    <area target="_self" alt="Resolution view" title="Resolution view" href="/manual/resolution-view.html" coords="256,462,994,589" shape="rect">
+    <area target="_self" alt="Repositories" title="Repositories" href="/manual/repositories-view.html" coords="250,559,0,408" shape="rect">
+</map>
+
+[1]: https://bnd.bndtools.org

_manual/bndeditor.md

@@ -0,0 +1,40 @@
+---
+title: Bnd Editor
+description: The Bnd properties editor for bnd files
+---
+
+The bnd editor provides a number of tabs with graphic editors. The following tabs are available:
+
+* [Contents](#contents) – The content and resulting imports of the selected bundle
+* [Description](#description) – Editor for the OSGi headers that describe a bundle
+* [Build](#build) – The build path
+* [Run](#run) – Create a launch configuration
+* [Tests](#tests) – Managing tests
+* [Source](#source) – Source code editor for the bnd properties file
+
+
+## Contents
+
+<img src="/images/bnd-editor-contents.png" style="width:772px" class="view">
+
+
+## Description
+
+<img src="/images/bnd-editor-description.png" style="width:772px"  class="view">
+
+
+## Build
+
+<img src="/images/bnd-editor-build.png" style="width:772px" class="view">
+
+## Run
+
+<img src="/images/bnd-editor-run.png" style="width:772px" class="view">
+
+## Tests
+
+<img src="/images/bnd-editor-tests.png" style="width:772px" class="view">
+
+## Source
+
+<img src="/images/bnd-editor-source.png" style="width:772px" class="view">

_manual/jareditor.md

@@ -0,0 +1,16 @@
+---
+title: JAR Viewer
+description: Shows the content of a JAR file with extra attention for OSGi information
+---
+
+* [Content](#content) – The content of the selected JAR
+* [Print](#print) – Summary of OSGi information
+
+## Content
+
+<img src="/images/jar-editor-content.png" style="width:772px" class="view">
+
+## Print
+
+<img src="/images/jar-editor-print.png" style="width:772px" class="view">
+ 

_manual/packageexplorer.md

@@ -0,0 +1,32 @@
+---
+title: Package Explorer
+description: An overview of the Package Explorer with Bndtools
+---
+
+The [Eclipse Package Explorer][1] provides an overview of the projects and their contents. Icons are used extensively to mark the projects. They are either used as direct icons for an object (e.g. a bnd.bnd file) or are used to decorate existing icons. For example, if a package is exported or not. The following image shows all icons in their context.
+ 
+ <img src="/images/package-explorer.png" alt="Package Explorer" style='width:481px' class="view"/>
+
+Bndtools adds the following icons in the Package Explorer:
+
+|----------------|------------------------------------------------------------------------------------------------|
+| ![bnd project file](/images/icons/bnd-project.png) | Contains all the project configuration. The project configuration inherits properties from from `cnf/build.bnd` and any bnd files in `cnf/ext/`|
+| ![*.bnd file](/images/icons/bnd-general.png) | A general bnd file. This is either a bnd file in the `cnf` directory to configure the workspace or it can be a sub bundle when in a project. Bndtools contains a special editor for the bnd files. This type of file is generally used in an inheritance hierarchy. |
+| ![*.bndrun file](/images/icons/bndrun.png) | Describes a launch configuration. The required bundles can be indicated with _initial requirements_ that the Bndtools resolver can turn into a list of bundles.  An extensive editor is available to edit the launch configuration. A project can contain many bndrun files.|
+| ![build.bnd](/images/icons/build-bnd.png) | This is the _master configuration_ file of the workspace. When Bndtools starts, bnd first reads the bnd files in the `cnf/ext/` directory, and then the `cnf/build.bnd` file. Any property or header set in this file is available to any project. There is only one such file in a workspace and it is also used as the _marker_ file for a workspace. |
+| ![Bnd Bundle Path](/images/icons/library.png) | `Bnd Bundle Path` – This is an _Eclipse Library container_ for Bndtools. The children of the container are specified in the project's `bnd.bnd` file in the `-buildpath` and `-testpath` instructions. Entries from the `-testpath` are shaded since Eclipse Photon and bnd 4.1.0. The entries are automatically updated when changes are made to the workspace.|
+| ![Dependency with attached source](/images/icons/jar-src.png) | A `Bnd Bundle Path` dependency with source code attached. If the icon is darker then it is a test dependency.  |
+| ![Dependency](/images/icons/jar.png) | A `Bnd Bundle Path` dependency without source code attached.  If the icon is darker then it is a test dependency. |
+| ![Dependency](/images/icons/jar-test.png) | A `Bnd Bundle Path` dependency without source code attached that is only used for test code. |
+| ![Component class](/images/icons/java-component.png) | A class that is a DS component. The general icon for a component is an eco friendly  green LED. |
+| ![Component package](/images/icons/package-component.png) | A package that contains DS components |
+| ![src folder](/images/icons/src-main.png) | The source folder classes that are part of the bundle |
+| ![test folder](/images/icons/src-test.png) | The source folder for test code. |
+| ![Private package](/images/icons/package-private.png) | A private package in a bundle. This package is included but not exported.|
+| ![Exported package](/images/icons/package-exported.png) | An exported package of a bundle. If the package has a version it will also be displayed.|
+| ![Excluded package](/images/icons/package-excluded.png) | A package that is **not** included in any bundle. This is rare and not a good practice so it is generally a warning sign.|
+
+If you're looking for other icons, the [Eclipse Help](http://help.eclipse.org/kepler/index.jsp?topic=%2Forg.eclipse.jdt.doc.user%2Freference%2Fref-icons.htm) shows a further reference of all icons.
+
+
+[1]: https://help.eclipse.org/photon/index.jsp?topic=%2Forg.eclipse.jdt.doc.user%2Ftasks%2Ftasks-74.htm

_manual/repositories-view.md

@@ -0,0 +1,6 @@
+---
+title: Repositories View
+description: Shows the repositories and their contents
+---
+
+<img src="/images/repositories-view.png" style="width:461px" class="view">

_manual/resolution-view.md

@@ -0,0 +1,6 @@
+---
+title: Resolution View
+description: Provides insight into the requirements and capabilities of the selected bundle
+---
+
+<img src="/images/resolution-view.png" style="width:750px" class="view">

css/style.scss

@@ -8,4 +8,13 @@
 
 table {
     width: 100%;
+}
+
+img { width: auto; max-width: fit-content;}
+
+img.view {
+    border-radius: 10px;
+    border: 1px solid grey;
+    padding: -2px;
+    box-shadow: 5px 5px 2px lightgrey;
 }

icons.md

@@ -0,0 +1,10 @@
+---
+title: Legend
+description: A description of each icon used in Bndtools
+---
+
+|----------------|------------------------------------------------------------------------------------------------|
+|![add][add]     | Add element to a list. In general you can also use an appropriate drag and drop                |
+
+
+[add]: https://github.com/bndtools/bndtools/raw/master/bndtools.core/resources/unprocessed/icons/add_obj.png