Bug 545419 - [Passage] provide help materials "How to customize
Licensing UI for your product"
How to materials provided
Change-Id: I4a2b0c10175b4466c1bcc262e6df7d20ceaa670a
diff --git a/eclipse.passage.howto.licensing.color.configuration.html b/eclipse.passage.howto.licensing.color.configuration.html
new file mode 100644
index 0000000..9882099
--- /dev/null
+++ b/eclipse.passage.howto.licensing.color.configuration.html
@@ -0,0 +1,44 @@
+<!DOCTYPE html>
+<html>
+
+<head>
+ <meta charset="utf-8">
+ <meta name="viewport" content="width=device-width, initial-scale=1.0">
+ <title>Welcome file</title>
+ <link rel="stylesheet" href="https://stackedit.io/style.css" />
+</head>
+
+<body class="stackedit">
+ <div class="stackedit__html"><h2 id="how-to-customise-licensing-colors-for-product.">How to customize licensing colors for product.</h2>
+<p>Eclipse Passage allows you to configure the color schema for licensing restriction level representation.<br>
+The licensing status dialog displays product components to be licensed.</p>
+<p>The level of licensing restrictions are</p>
+<ul>
+<li>INFO - inform about functionality restriction without pausing the execution flow;</li>
+<li>WARNING - pause the execution flow with warning, but allow to proceed without functionality blocking;</li>
+<li>ERROR - interrupt the execution for the restricted functionality with error, but allow to use other scenarios;</li>
+<li>FATAL - terminate the execution with fatal error;</li>
+</ul>
+<p>Particular level refers to own color scheme defined for the specific product. Licensing restrictions color can be configured from settings dialog or using <strong>preferenceCustomization</strong>.</p>
+<p>To customize the licensing color scheme by following steps:</p>
+<ul>
+<li>specify the file containing default preference values for the product via extension point <strong>org.eclipse.core.runtime.products</strong> by adding:</li>
+</ul>
+<pre class=" language-java"><code class="prism language-java"><span class="token operator"><</span> property
+ name<span class="token operator">=</span><span class="token string">"preferenceCustomization"</span>
+ value<span class="token operator">=</span><span class="token string">"platform:/<bundle>/plugin_customization.ini"</span><span class="token operator">/</span><span class="token operator">></span>
+</code></pre>
+<p>Add lines to file <strong>“plugin_customization.ini”</strong> file with next format:</p>
+<pre class=" language-java"><code class="prism language-java">org<span class="token punctuation">.</span>eclipse<span class="token punctuation">.</span>passage<span class="token punctuation">.</span>lic<span class="token punctuation">.</span>jface<span class="token operator">/</span>COLOR_LEVEL_OK <span class="token operator">=</span> RGB <span class="token punctuation">{</span> <span class="token number">100</span> <span class="token punctuation">,</span> <span class="token number">200</span><span class="token punctuation">,</span> <span class="token number">255</span><span class="token punctuation">}</span>
+org<span class="token punctuation">.</span>eclipse<span class="token punctuation">.</span>passage<span class="token punctuation">.</span>lic<span class="token punctuation">.</span>jface<span class="token operator">/</span>COLOR_LEVEL_INFO <span class="token operator">=</span> RGB <span class="token punctuation">{</span> <span class="token number">120</span><span class="token punctuation">,</span> <span class="token number">255</span><span class="token punctuation">,</span> <span class="token number">255</span><span class="token punctuation">}</span>
+org<span class="token punctuation">.</span>eclipse<span class="token punctuation">.</span>passage<span class="token punctuation">.</span>lic<span class="token punctuation">.</span>jface<span class="token operator">/</span>COLOR_LEVEL_WARN <span class="token operator">=</span> RGB <span class="token punctuation">{</span> <span class="token number">120</span><span class="token punctuation">,</span> <span class="token number">255</span><span class="token punctuation">,</span> <span class="token number">255</span><span class="token punctuation">}</span>
+org<span class="token punctuation">.</span>eclipse<span class="token punctuation">.</span>passage<span class="token punctuation">.</span>lic<span class="token punctuation">.</span>jface<span class="token operator">/</span>COLOR_LEVEL_ERROR <span class="token operator">=</span> RGB <span class="token punctuation">{</span> <span class="token number">130</span> <span class="token punctuation">,</span> <span class="token number">255</span><span class="token punctuation">,</span> <span class="token number">255</span><span class="token punctuation">}</span>
+org<span class="token punctuation">.</span>eclipse<span class="token punctuation">.</span>passage<span class="token punctuation">.</span>lic<span class="token punctuation">.</span>jface<span class="token operator">/</span>COLOR_LEVEL_FATAL <span class="token operator">=</span> RGB <span class="token punctuation">{</span> <span class="token number">130</span> <span class="token punctuation">,</span> <span class="token number">255</span><span class="token punctuation">,</span> <span class="token number">255</span><span class="token punctuation">}</span>
+</code></pre>
+<p>The color specification represent in terms of the primary additive color model (red, green and blue):</p>
+<pre class=" language-java"><code class="prism language-java"><span class="token operator">-</span> RGB <span class="token punctuation">{</span>red<span class="token punctuation">,</span>green<span class="token punctuation">,</span>blue<span class="token punctuation">}</span>
+</code></pre>
+</div>
+</body>
+
+</html>
diff --git a/index.php b/index.php
index 87d6e99..5af6c77 100644
--- a/index.php
+++ b/index.php
@@ -14,19 +14,12 @@
// # Paste your HTML content between the EOHTML markers!
$html = <<<EOHTML
- <div>
- <img
- class="displayed"
- src="/passage/images/title.png"
- height="200"
- alt="Eclipse Passage Title"
- border="0"/>
- </div>
- <div id="midcolumn">
+
+<div id="midcolumn">
<h3>Eclipse Passage (License Management Solution)</h3>
<div id="introText">
-<p>
+ <p>
The Eclipse Passage project aims to provide rich and easily adaptable capabilities to define and control licensing constraints.
<p/>
The Eclipse Passage represents several sets of components for license management:
@@ -44,14 +37,13 @@
Easy to use, simple to integrate, cheap to maintain.
-</p>
+ </p>
<img
- class="displayed"
- src="/passage/images/snapshot.png"
- height="550"
- alt="Eclipse Passage Snapshots"
- border="0"/>
-
+ class="displayed"
+ src="/passage/images/snapshot.png"
+ height="550"
+ alt="Eclipse Passage Snapshots"
+ border="0"/>
</div>
</div>
@@ -67,6 +59,9 @@
<i>The first release of Eclipse Passage at Eclipse Foundation is in progress.</i>
</a>
</p>
+ <h3> How To Passage</h3>
+ <a href="eclipse.passage.howto.licensing.color.configuration.html">
+ <i>How to customize licensing colors for product</i>
</div>
</div>
EOHTML;
