Skip to content

Commit 5306192

Browse files
committed
comment fixes/typos (punctuation, blank lines, leading/trailing whitespaces cleanup)
git-svn-id: https://share-extras.googlecode.com/svn/trunk/Sandbox/Audit Dashlet@797 a3f5c567-fd0f-3a89-9b71-a290c5a5f590
1 parent 4e47d00 commit 5306192

File tree

9 files changed

+214
-207
lines changed

9 files changed

+214
-207
lines changed

README.txt

Lines changed: 23 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -3,10 +3,10 @@ Audit Application dashlet for Alfresco Share
33

44
Author: Romain Guinot
55

6-
This project defines a custom dashlet to display events for any given audit application.
6+
This project defines a custom dashlet to display events for any given audit application.
77

88
The dashlet will need to have auditing application(s) already configured, and, to be useful, some events captured.
9-
See http://wiki.alfresco.com/wiki/Auditing_(from_V3.4) on how to define audit applications and some samples.
9+
See http://wiki.alfresco.com/wiki/Auditing_(from_V3.4) on how to define audit applications and some samples.
1010

1111
From 3.4.4, also see http://wiki.alfresco.com/wiki/Content_Auditing and http://wiki.alfresco.com/wiki/Audit_Filter.
1212

@@ -50,10 +50,10 @@ Using the dashlet
5050
Log in to Alfresco Share and navigate to a site or user dashboard. Click the 'Customize Dashboard' button to edit the contents
5151
of the dashboard and drag the dashlet into one of the columns from the list of dashlets.
5252

53-
* Configuration :
53+
* Configuration :
5454

55-
Click Configure to choose an existing audit application. Results will appear as you type and will be matched
56-
against the live list of audit applications as reported by /api/audit/control.
55+
Click Configure to choose an existing audit application. Results will appear as you type and will be matched
56+
against the live list of audit applications as reported by /api/audit/control.
5757

5858
For convenience, the list will pop out when opening the configure dialog with no applications currently configured.
5959
Could be useful if you don't know what application name to search for.
@@ -72,12 +72,12 @@ of the dashboard and drag the dashlet into one of the columns from the list of d
7272
The columns to display are also configurable (show/hide).
7373

7474
Note : the output in the "audited values" field will depend on the configuration of the current audit application.
75-
(ie what data extractors have been configured, if using the access auditor or not, etc ...).
75+
(ie what data extractors have been configured, if using the access auditor or not, etc...).
7676

7777
* Search box
78-
79-
The dashlet search box allows more search capabilities than the server side filter, ie :
80-
- field to search on (regex or not), e.g :
78+
79+
The dashlet search box allows more search capabilities than the server side filter, ie :
80+
- field to search on (regex or not), e.g :
8181
id:14
8282
id:1.95$
8383
name:romain
@@ -87,23 +87,28 @@ of the dashboard and drag the dashlet into one of the columns from the list of d
8787
-name:ro
8888
-values:pro
8989

90-
- mutliline matches are enabled, ^ and $ will match beginning of lines for audit values,
90+
- mutliline matches are enabled, ^ and $ will match beginning of lines for audit values,
9191
useful since there can be more than one line per audit entry
9292

9393
- query can match anywhere in the field by default. queries can be any valid javascript regular expression.
94-
examples : ^romain, values:r.m...$ , id:\d\d8, -time:21 ...
94+
examples :
95+
^romain
96+
values:r.m...$
97+
id:\d\d8
98+
-time:21
99+
95100
The search box will turn green or red if the regex is valid or invalid, respectively
96101
query can be restricted to the beginning by using ^romain (standard regex) for example.
97102
See https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/regexp for more details.
98103

99-
Each match of the regex in the audit entry will be highlighted. Deferred submatches are also supported for highlighting.
104+
Each match of the regex in the audit entry will be highlighted. Deferred submatches are also supported for highlighting.
100105

101106
- to search for a colon (:), use the field prefix, eg; field:.+:.+ or values:[^:]+: etc... otherwise the colon will be interpreted
102107
as a field identifier
103108

104109
- noderefs in the audit values will be detected, and "enhanced" with a link to the docdetails page of that noderef
105110

106-
- multi field search is currently not supported, e.g +id:95 -name:romain. Would have to support ( ) , and/or grouping ,etc ...
111+
- multi field search is currently not supported, e.g +id:95 -name:romain. Would have to support ( ), and/or grouping, etc...
107112

108113
This search is done by filtering out undesired entries coming from the datasource prior to browser display.
109114

@@ -115,11 +120,12 @@ Changelog
115120
- some css cleanup
116121
- some UI label changes
117122
- updated YUI compressor to 2.4.7
123+
- leading/trailing whitespaces cleanup
118124

119125
0.4:
120126
- datatable columns can now be configured to be shown or hidden
121127
- an extra field has been added to the config dialog to pass additional server side query parameters.
122-
See the wiki documentation (http://wiki.alfresco.com/wiki/Auditing_(from_V3.4)#Advanced_Query) and the web script description.
128+
See the wiki documentation (http://wiki.alfresco.com/wiki/Auditing_(from_V3.4)#Advanced_Query) and the web script description.
123129
- datatable css fix for google chrome, and various css tweaks
124130
- Added help link opposite the config link
125131
- tweaked what links (configure, help) are shown to admins / site managers
@@ -140,8 +146,8 @@ Changelog
140146
- better cross-browser support
141147
- rows per page now configurable in the config dialog
142148

143-
0.22:
144-
- small bug fix : regex remainder fix
149+
0.22:
150+
- small bug fix : regex remainder fix
145151
- bug fix : generated docdetails and profile links were incorrect when a regex search was already in progress
146152
- lots of other small regex corner cases fixed
147153
- search box background now green or red, depending on whether or not the user search is a valid regex or not, respectively
@@ -150,6 +156,6 @@ Changelog
150156

151157
0.21: small bug fixes : highlighting multiple matches and regression when clearing the search box
152158

153-
0.2 : search box / query filtering
159+
0.2 : search box / query filtering
154160

155161
0.1 : inital release

0 commit comments

Comments
 (0)