More about this Plugin
Autogenerates a table based on an eventlog and show the associated eventlog entries, all based on user input.
Administrators
Administrator might need to be involved depending on the security settings of the machine which is hosting the wiki and the remote machines with eventlogs which might be contacted.
Note that this plugin creates it's own help and test pages inside your wiki, for your benefit.
These pages cannot be deleted without disabeling the formatter first.
Markup Usage
What can you do?
- Generate a table of eventlog entries.
- Filter eventlog by 1 or more of the following: Id, Type, Date, Time, Source, Category, Event, User, Computer and Description
- Contact remote machine's event logs (permission setup might be required)
- Limit your search result by setting an upper limit
- Display one or more of the following eventlog properties:
- type
- date
- time
- source
- category
- event
- user
- computer
- description
Usage:
{ EventLog machine= log= filter= results= }
Where:
- Data:
- machine - Name/IP of a the machine to fetch the eventlog from. Ommit for localhost.
- log - Name of the log
- filter - Filter to limit the search results. Use the following filters, seperate by ",".
- "Id" - Index id of the entry
- "Type" - Must be one of:
- Information
- Warning
- Error
- InfoAndWarn
- InforAndError
- WarnAndError
- "Date" - Date and time the eventlog entry was created, may depend on machine setup (ex. 01-01-2010 or 01-01-2010 01:30:00 )
- This is a eventlogdate >= myDate test.
- Alternatively use: -1 or -x for days to look back, ex ,date=-1,
- "Time" - Date and time the eventlog was written, may depend on machine setup (ex. 01-01-2010 or 01-01-2010 01:30:00 )
- Alternatively use: -1 or -x for days to look back, ex ,date=-1,
- This is always a eventlogtime >= myTime test.
- "Source" - Source of the eventlog entry
- "Category" - Category of the eventlog entry
- "Event" - EventId/InstanceId of the eventlog entry
- "User" - User name of the eventlog entry
- "Computer" - Computer name of the eventlog entry
- "Description" - Actual eventlog entry description. When using this field a string search will be performed, so use keywords such as: MyApp, database or other.
- "' '" - does not apply to this field, search must match entry string to reveal results.
- Results - Number which limits the amount of results returned, use this with care since it may be VERY cpu intensive to query the eventlog and scan for matches. Default is 15 results.
- To display additional columns use the table tags found here further down this page. Simply use the values described above in the 'cols' argument.
All args which have a value that contains whitespaces, must be encapsulated in ' ', ex. 'My Category'.
Example
For more examples
including filtering, visit my site.
Tables and Styling ¶
The
Keeper Garrett Screwturn Formatters currently consists of 4 formatters which all uses the same tables and styling scheme, they are:
For a visual preview of the supplied styles visit my site:
http://keeper.endoftheinternet.org Markup Usage
What can you do?
- Add a heading to your table
- Add a footer to your table
- Show only specified columns
- Change column order
- Override column headers
- Use one of the 11 predefined styles
- Define your own style
- Use the default wiki theme style
- Use the default generic wiki theme style
Usage:
{SomeFormatter( ...Formatter_Specific_Args=XX... head=XXX foot=YYY cols=ZZZ colnames=XYZ style=ZXY}
Where:
- head - Heading of the table
- foot - Footer of the table
- cols - Name and order of the columns to show, must be seperated by ,. Ex. 'col1,col2,col3'
- colnames - Custom column names, must be seperated by ,. Ex. 'col1,col2,col3'
- style - Name of one of the predefined styles, if not specified the default wiki style is used.
All args which have a value that contains whitespaces, must be encapsulated in ' ', ex. 'My Heading'.
Add A Heading
Markup:
{SomeFormatter( ... head='My Heading'}
Result:
My Heading | Col1 | Col2 |
|---|
| DataCell1 | DataCell2 |
Add A Footer
Markup:
{SomeFormatter( ... foot='My Footer'}
Result:
| Col1 | Col2 |
|---|
| DataCell1 | DataCell2 |
Change Column Order and Display ¶
Markup:
{SomeFormatter( ... cols='Col1,Col3,Col2'}
Result:
| Col1 | Col3 | Col2 |
|---|
| DataCell1 | DataCell3 | DataCell2 |
Here a 4 column called Col4 is omitted since it is not mentioned.
Change Column Names ¶
Markup:
{SomeFormatter( ... colnames='X,Y,Z'}
Result:
| X | Y | Z |
|---|
| DataCell1 | DataCell2 | DataCell3 |
OR
Markup:
{SomeFormatter( ... cols='Col1,Col3,Col2' colnames='X,Y,Z'}
Result:
| X | Y | Z |
|---|
| DataCell1 | DataCell3 | DataCell2 |
Styling
For a visual preview of the supplied styles visit my site:
/Keeper.Garrett.Formatters/Tables/table-examples.html
Markup:
{SomeFormatter( ... style='generic'}
If the style argument is not supplied the default wiki table style is used.
There are 2 theme based styles and 11 predefined styles which are bundled with all the formatters (which uses tables).
Wiki Theme styles:
- No style specified - will use the current theme's default style
- generic - will use the current theme's generic style
- There's a small section in the TableStyle.css which removes the generic padding so that the generic style mathces the one used in the wiki. Uncomment the generic section if you do not like this and save the TableStyle.css.
Predefined table styles:
- hor-minimalist-a
- hor-minimalist-b
- ver-minimalist
- box-table-a
- box-table-b
- hor-zebra
- hor-zebra-a
- hor-zebra-b
- rounded-corner
- background-image
- gradient-style
All these styles are defined in the TableStyle.css file which is located in default file storage provider on the following path:/Keeper.Garrett.Formatters/Tables/TableStyle.css
So to create your own custom style simply add your CSS to this file.
Examples
Discuss
No Messages for this Page. Be the first!