updated README to markdown syntax due to GitHub migration

Romain GUINOT · Romain GUINOT · commit 1a28b4795f98 · 2013-07-24T14:53:16.000+02:00
diff --git a/README.md b/README.md
@@ -15,28 +15,27 @@ Installation
 
 The dashlet has been developed to install on top of an existing Alfresco 3.4 installation.
 
-* Users : Prebuilt jar
+ * **Users : Prebuilt jar**
 
     A prebuilt jar is provided. You only need to copy it to <tomcat-home>/shared/lib.
 
-* Developers : Building the jar
+ * **Developers : Building the jar**
 
     For developers, an Ant build script is provided to build a JAR file containing the
     custom files, which can then be installed into the 'tomcat/shared/lib' folder
     of your Alfresco installation.
 
-    To build the JAR file, run the following command from the base project
-    directory.
+    To build the JAR file, run the following command from the base project directory.
 
-    ant clean dist-jar
+        ant clean dist-jar
 
     The command should build a JAR file named sample-audit-dashlet.jar in the 'dist' directory within your project.
 
     To deploy the dashlet files into a local Tomcat instance for testing, you can
-    use the hotcopy-tomcat-jar task. You will need to set the tomcat.home
+    either copy the jar file in e.g. the 'tomcat/shared/lib' folder or use the hotcopy-tomcat-jar task. You will need to set the tomcat.home
     property in Ant.
 
-    ant -Dtomcat.home=C:/Alfresco/tomcat clean hotcopy-tomcat-jar
+        ant -Dtomcat.home=C:/Alfresco/tomcat clean hotcopy-tomcat-jar
 
     Once you have run this you will need to restart Tomcat so that the classpath resources in the JAR file are picked up.
 
@@ -47,10 +46,15 @@ The dashlet has been developed to install on top of an existing Alfresco 3.4 ins
 Using the dashlet
 -----------------
 
-Log in to Alfresco Share and navigate to a site or user dashboard. Click the  'Customize Dashboard' button to edit the contents
-of the dashboard and drag the dashlet into one of the columns from the list of dashlets.
+ * **Adding the dashlet**
 
- * Configuration :
+  - Log in to Alfresco Share and navigate to a site where you are a Site Manager, or to your user dashboard.
+  - Click the *Customize Dashboard* button to edit the contents of the dashboard. Drag the `Audit Application` dashlet into one of the columns from the list of dashlets to add it.
+  - Click OK to save the configuration.
+  - The dashlet should now be shown in your dashboard.
+
+
+ * **Configuration** :
 
     Click Configure to choose an existing audit application. Results will appear as you type and will be matched
     against the live list of audit applications as reported by /api/audit/control.
@@ -61,69 +65,89 @@ of the dashboard and drag the dashlet into one of the columns from the list of d
     The number of data rows (audit events) displayed per page is configurable with the 'Entries per page' parameter. It defaults to 10.
 
     Additional server side filters are configurable :
-            UI Name                              Description                                                   Audit API corresponding parameter
-    -----------------------------------------------------------------------------------------------------------------------------------------------------
-    - Value Filter                  filter on the audit value (exact match, optional)                          'value'
-    - Max Entry Count               maximum number of audit entries retrieved (optional)                       'limit' (default 100)
-    - Audit Path Filter             select only the audit entries with a matching audit path                   URL path after application (default none)
-                                    key in their values map. (optional)
-    - Additional Query params       other possible server-side query parameters (optional). Separated by &.    from/to time, from/to id, user, valueType, ...
-                                    (See http://wiki.alfresco.com/wiki/Auditing_(from_V3.4)#Advanced_Query).
 
-    The columns to display are also configurable (show/hide).
+            UI Name                |              Description                                                                      |  Audit API corresponding parameter
+    ------------------------------ | --------------------------------------------------------------------------- | ------------------------------------
+     Value Filter                  | filter on the audit value (exact match, optional)                           | 'value'
+     Max Entry Count               | maximum number of audit entries retrieved (optional)                        | 'limit' (default 100)
+     Audit Path Filter             | select only the audit entries with a matching audit path key (optional) (1) | URL path after application (default none)
+     Additional Query params       | other possible server-side query parameters (optional). Separated by &  (2) | from/to time, from/to id, user, valueType, ...
+
+
+    (1) The match must occur in the values map for that key within the entry.  
+    (2) See http://wiki.alfresco.com/wiki/Auditing_(from_V3.4)#Advanced_Query for more information.  
+
+
+    - The columns to display are also configurable (show/hide).
+
+    - The output in the "audited values" field will depend on the configuration of the current audit application.
+      (ie what data extractors have been configured, if using the access auditor or not, etc...).
+
+    - Querying for values when an audit path query is configured will restrict the search to entries with that value for that specific audit path.
 
-    Note : the output in the "audited values" field will depend on the configuration of the current audit application.
-    (ie what data extractors have been configured, if using the access auditor or not, etc...).
+    - The "Trim Audit Paths" checkbox can be used to show the full audit paths up to the audit key, or just the audit key, in the audit values.
+      It can be useful to temporarily turn on in case one wants to use the audit path filter above, as it will show the full audit paths required for that filter.
 
-    Note : querying for values when an audit path query is configured will restrict the search to entries with that value for that specific audit path.
+    - The data webscript does a version check to determine if a workaround for the unquoted json feed prior to 3.4.3 Enterprise / 4.0 Community (ALF-8307) is required.
+      This can be overriden by copying the webscript config file (audit-application-data.get.config.xml) in the equivalent path in web-extension, if required.
 
-    The "Trim Audit Paths" checkbox can be used to show the full audit paths up to the audit key, or just the audit key, in the audit values.
-    It can be useful to temporarily turn on in case one wants to use the audit path filter above, as it will show the full audit paths required for that filter.
 
-    Note : The data webscript does a version check to determine if a workaround for the unquoted json feed prior to 3.4.3 Enterprise / 4.0 Community (ALF-8307) is required.
-    This can be overriden by copying the webscript config file (audit-application-data.get.config.xml) in the equivalent path in web-extension, if required.
 
- * Search box
+ * **Search box**
 
     The dashlet search box allows more search capabilities than the server side filter, ie :
-    - field to search on (regex or not), e.g :
-        id:14
-        id:1.95$
-        name:romain
-        etc...
+    - Field to search on (regex or not), e.g :  
 
-    - negation, e.g
-        -name:ro
-        -values:pro
+            id:14  
+            id:1.95$  
+            name:romain  
 
-    - mutliline matches are enabled, ^ and $ will match beginning of lines for audit values,
-        useful since there can be more than one line per audit entry
+        etc...  
+        If not specified, the 'values' field will be assumed.
 
-    - query can match anywhere in the field by default. queries can be any valid javascript regular expression. examples :
-        ^romain
-        values:r.m...$
-        id:\d\d8
-        -time:21
+
+    - Negation, e.g  
+
+            -name:ro  
+            -values:pro  
+
+    - Multiline matches are enabled, ^ and $ will match beginning and end of lines for audit values,
+        useful since there can be more than one line per audit entry.
+
+    - Query can match anywhere in the field by default. Queries can be any valid javascript regular expression. Examples :  
+
+            ^romain  
+            values:r.m...$  
+            id:\d\d8  
+            -time:21  
 
       The search box will turn green or red if the regex is valid or invalid, respectively.
       The query can be restricted to the beginning by using ^romain (standard regex), for example.
       See https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/regexp for more details.
 
       Each match of the regex in the audit entry will be highlighted. Deferred submatches are also supported for highlighting.
 
-    - to search for a colon (:), use the field prefix, eg; field:.+:.+ or values:[^:]+: etc... otherwise the colon will be interpreted
-        as a field identifier
+    - To search for a colon (:), use the field prefix, eg; field:.+:.+ or values:[^:]+: etc... otherwise the colon will be interpreted
+        as a field identifier.
 
-    - noderefs in the audit values will be detected, and "enhanced" with a link to the docdetails page of that noderef
+    - Noderefs in the audit values will be detected, and "enhanced" with a link to the docdetails page of that noderef.
 
-    - multi field search is currently not supported, e.g +id:95 -name:romain. Would have to support ( ), and/or grouping, etc...
+    - Multi field search is currently not supported, e.g +id:95 -name:romain. Would have to support ( ), and/or grouping, etc...
 
     This search is done by filtering out undesired entries coming from the datasource prior to browser display.
 
+
 Changelog
 ---------
 
+0.51:
+
+    - no new features or bugfixes
+    - moved README to markdown syntax due to GitHub migration
+    - small css class name changes
+
 0.5:
+
     - fixed config dialog URL to use /res, required in 4.2. addresses issue 129.
     - added the configurable server-side ability to query for entries containing a specific audit path.
          Note : querying for values when an audit path query is configured will restrict the search to entries with that value for that specific audit path.
@@ -134,33 +158,39 @@ Changelog
     - fixed an unreported issue where storing config values with double quotes in the text would prevent the config options to be loaded afterwards.
 
 0.45:
+
     - refined workaround against unquoted json feed for application and user json properties
     - apply this workaround only when running against a repository affected by the bug
     - minor CSS fix : historical margins for dashlet body no longer required.
 
 0.44:
+
     - expanded workaround against unquoted json feed for application and user json properties. addresses issue 71.
     - additional newline sanitizing of the server side json feed, in addition to the checks already present in the freemarker output. possibly addresses issue 82.
     - rationalized indentation to 3 spaces and cleanup the tabs that have built up over time
 
 0.43:
+
     - allow the 'additional' query string to override any other configured options, not just the sort order
     - switched the copyright header from 'Share Extras project' to 'Share Extras contributors'
 
 0.42:
+
     - switched to share extras namespace
     - some comments and jsdoc review
     - aligned rowsPerPage / defaultRowsPerPage data types
     - merged some build.xml changes from upstream
 
 0.41:
+
     - better IE support
     - some css cleanup
     - some UI label changes
     - updated YUI compressor to 2.4.7
     - leading/trailing whitespaces cleanup
 
 0.4:
+
     - datatable columns can now be configured to be shown or hidden
     - an extra field has been added to the config dialog to pass additional server side query parameters.
         See the wiki documentation (http://wiki.alfresco.com/wiki/Auditing_(from_V3.4)#Advanced_Query) and the web script description.
@@ -169,11 +199,13 @@ Changelog
     - tweaked what links (configure, help) are shown to admins / site managers
 
 0.31:
+
     - build.properties more consistent with other projects
     - distributed jar had a wrong french bundle filename
     - added small precision in the README
 
 0.3:
+
     - some formatting, commenting, refactored to separate search box UI background coloring from the actual filtering
     - highlighting can now be expressed with CSS, rather than hardcoded html bold
     - deferred submatches highlighting support
@@ -185,15 +217,22 @@ Changelog
     - rows per page now configurable in the config dialog
 
 0.22:
+
     - small bug fix   : regex remainder fix
     - bug fix : generated docdetails and profile links were incorrect when a regex search was already in progress
     - lots of other small regex corner cases fixed
     - search box background now green or red, depending on whether or not the user search is a valid regex or not, respectively
     - ability to list all applications in the config dialog by searching for a leading space, if one does not know what to search for
     - renamed some files and web scripts URLs
 
-0.21: small bug fixes : highlighting multiple matches and regression when clearing the search box
+0.21:
+
+    - small bug fixes : highlighting multiple matches and regression when clearing the search box
+
+0.2 :
+
+    - search box / query filtering
 
-0.2 : search box / query filtering
+0.1 :
 
-0.1 : inital release
+    - inital release
