Support metadata

index.html

@@ -192,6 +192,10 @@ <h3>The axes of Semantic Release Notes </h3>
                                 Additionally the release note should be able to indicate what category an item is. For instance, 
                                 "+New", "+Change", "+Bug-Fix", +Developer". This is indicated via a single word, or - (dash) delimited phrase, that has a "+" prefix. 
                             </li>
+                            <li>
+                                <strong>Metadata</strong>:
+                                A list of metadata can be added to a release note. Only some elements are possible, with their respective specific syntax.
+                            </li>
                             <li>
                                 <strong>Release</strong>:
                                 As SRN allows for many releases to be defined within the one block of text, the system needs 
@@ -313,7 +317,35 @@ <h3>Category</h3>
                         <div class="result"></div>
                         <pre class="object"></pre>
                     </div> 
-
+
+                    <h3>Metadata</h3>
+                    <p>
+                        It can be useful to add some metadata to a release note, for example the list of commits targeted by the release note.
+                    </p>
+                    <p>
+                        All metadata can be preceded by its name (case insensitive) followed by a colon, but each supported metadata have it's own syntax:
+                        <ul>
+                            <li>Commits: the first and last commits separated by three dots, included or not in a link. Name optional.</li>
+                            <li>Contributors: list of all contributors for the release. Name mandatory.</li>
+                            <li>Source: link to the sources. Name mandatory.</li>
+                            <li>Binaries: link to the binaries. Name mandatory.</li>
+                            <li>Generated at: generation time of the release notes with the following format: yyyy-mm-ddTHH:mm:ssZ (ISO 8601). Name optional.</li>
+                        </ul>
+                    </p>
+                    <div class="container">
+                        <strong>Examples:</strong>
+                        <pre class="code">56af25a...d3fead4
+Commits: [56af25a...d3fead4](https://github.com/Glimpse/Semantic-Release-Notes/compare/56af25a...d3fead4)
+Contributors: Jérémie Bertrand, Jake Ginnivan, [Anthony van der Hoorn](https://github.com/avanderhoorn)
+source: [MyPackage.zip](https://github.com/laedit/MyPackage/archive/v0.1.0.zip)
+binaries: [MyPackage.exe](https://github.com/laedit/MyPackage/releases/download/v0.1.0/MyPackage.exe)
+Generated at: 2015-05-04T08:45:36Z
+2015-05-04T08:45:36Z
+                        </pre>
+                        <div class="result"></div>
+                        <pre class="object"></pre>
+                    </div>
+
                     <h3>Release (Not Working)</h3>
                     <p>
                         In some cases we want to have the one document that describes many releases. In this case, the 
@@ -378,7 +410,7 @@ <h3>Release (Not Working)</h3>
             <div>
                 <input name="menu-root-radio" class="menu-root-radio" id="Examples" type="radio" />
                 <div class="section-syntax"> 
-                    <a id="Exmaples"></a>
+                    <a id="Examples"></a>
                     <h2>Examples</h2>
                     <div class="section-editor">
                         <ul class="tabs">
@@ -455,7 +487,9 @@ <h2>Examples</h2>
 # Plugin [[icon][http://getglimpse.com/release/icon/mvc.png]]
 This description is specific to plugin section.
  1. *Timeline*: Comes with an additional grid view to show the same data. +Changed
- 1. *Ajax*: Fix that crashed poll in Chrome and IE due to log/trace statement. +Fix [[i1234][http://getglimpse.com]]</pre>
+ 1. *Ajax*: Fix that crashed poll in Chrome and IE due to log/trace statement. +Fix [[i1234][http://getglimpse.com]]
+
+Commits: [56af25a...d3fead4](https://github.com/Glimpse/Semantic-Release-Notes/compare/56af25a...d3fead4)</pre>
                                 <strong>Result:</strong>
                                 <div class="result"></div>
                                 <strong>Object:</strong>
@@ -518,14 +552,14 @@ <h2>Tools</h2>
         </section>  
         <footer>
             <div class="footer-inner">
-                Copyright &copy; 2013<br /> Anthony van der Hoorn &amp; Nik Molnar
+                Copyright &copy; 2015<br /> Anthony van der Hoorn &amp; Nik Molnar
             </div>
         </footer>
     </div>
 
 
     <script src="http://ajax.googleapis.com/ajax/libs/jquery/1.7.1/jquery.min.js"></script>
-    <script>window.jQuery || document.write('<script src="js/libs/jquery-1.7.1.min.js"><\/script>')</script> 
+    <script>window.jQuery || document.write('<script src="js/libs/jquery-1.7.1.min.js"><\/script>');</script> 
     <script src="js/script.js"></script> 
 <script type="text/javascript">
   var _gaq = _gaq || [];