Back
CategoryListFormatter Plugin

Modified on 2016/07/26 06:02 by BrianB Categorized as Uncategorized
{s:FormatterPluginPage
| image = [image:{UP(Customize.CategoryListFormatter)}Garrett.png]
| download_link = {UP}/Version/PluginPack/Keeper.Garrett.ScrewTurn.CategoryListFormatter.dll
| version = 2.0.1.0
| developer_link = [^http://master-garrett.blogspot.com/|Christian Hollerup Mikkelsen]
| update_date = 2016-01-09
| homepage = [^http://master-garrett.blogspot.com/|http://master-garrett.blogspot.com/]
| licence = GPLv2
| works_with = ScrewTurn Wiki v5.0.x
| languages = -
| visual_editor = no
}

Autogenerates a list/table of pages which are members of a category chosen by the user.

{TOC}
{BR}
=== Administrators ===
No special actions required.{BR}{BR}
'''Note however that this plugin creates it's own help and test pages inside your wiki, for your benefit.'''{BR}
'''These pages cannot be deleted without disabeling the formatter first.'''
{BR}

=== Markup Usage ===
'''What can you do?'''{BR}
* Generate a list/table of pages that match a certain category
* Use numbered/unnumbered lists (# or *)
* Choose wether among the following page properties to display:
** comment
** summary
** keywords
** lastmodified
** linkedpages
** createtime
** pagename
** user
** creator
* Choose one or more Namespaces to search in, the namespace must of course contain the same category
* Use styled tables instead of lists or even your own custom style.
{BR}

(((
'''Usage:'''{BR}{BR}
'''{ CategoryList cat= type= }'''{BR}{BR}
'''Where:''' {BR}
* ''Required:''
** '''cat''' - Name of a valid category
* ''Optional:''
** '''ns''' - Namespace(s) to search for pages in, ex. ns=root or ns='root,ProjectX'.
*** Default the current Namespace is used
** '''type''' - Can be 1 of 4, '''*,#, or table'''
*** '''"*"'''- Means unnumbered list
*** '''"#"'''- Means numbered list
*** '''"table"''' - Means use table instead of list
*** Default is *
* To display additional columns use the table tags found here further down this page. Simply use the values described above in the 'cols' argument.
{BR}
'' All args which have a value that contains whitespaces, must be encapsulated in ' ', ex. 'My Category'.  ''
)))
{BR}

==== Example ====
On my homepage and at my work I use this plugin for handling small easy tasks/reminders.
(((
[image||{UP(Customize.CategoryListFormatter)}CategoryFor1.png]
)))
{BR}

==== Minimum ====
The combinations of lists.{BR}
(((
'''Markup:'''{BR}{BR}
'''{ CategoryList cat=MyCat type=* }''' {BR}{BR}
'''Result:'''{BR}

* [Page1|Page Link1]
* [Page2|Page Link2]
* [Page3|Page Link3]
)))
{BR}
(((
'''Markup:'''{BR}{BR}
'''{ CategoryList cat=MyCat type=# }''' {BR}{BR}
'''Result:'''{BR}

1. [Page1|Page Link1]{BR}
2. [Page2|Page Link2]{BR}
3. [Page3|Page Link3]{BR}
)))
{BR}
(((
'''Markup:'''{BR}{BR}
'''{ CategoryList cat=MyCat type=* cols=summary }''' {BR}{BR}
'''Result:'''{BR}

* [Page1|Page Link1] - Page Summary
* [Page2|Page Link2] - Page Summary
* [Page3|Page Link3] - Page Summary
)))
{BR}
(((
'''Markup:'''{BR}{BR}
'''{ CategoryList cat=MyCat type=# cols='summary,user' }''' {BR}{BR}
'''Result:'''{BR}

1. [Page1|Page Link1] - Page Summary - Username{BR}
2. [Page2|Page Link2] - Page Summary - Username{BR}
3. [Page3|Page Link3] - Page Summary - Username{BR}
)))
{BR}
(((
'''Markup:'''{BR}{BR}
'''{ CategoryList cat=MyCat ns=ProjectX type=# cols='summary,user' }''' {BR}{BR}
'''Result:'''{BR}

1. [ProjectX.Page1|Page Link1] - Page Summary - Username{BR}
2. [ProjectX.Page2|Page Link2] - Page Summary - Username{BR}
3. [ProjectX.Page3|Page Link3] - Page Summary - Username{BR}
)))
{BR}

=== Tables and Styling ===
The Keeper Garrett Screwturn Formatters currently consists of 4 formatters which all uses the same tables and styling scheme, they are:{BR}
* [CategoryListFormatter|CategoryListFormatter]
* [EventLogFormatter|EventLogFormatter]
* [FileListFormatter|FileListFormatter]
* [QueryTableFormatter|QueryTableFormatter]
{BR}

==== Markup Usage ====
'''What can you do?'''{BR}
* 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
{BR}

(((
'''Usage:'''{BR}{BR}
'''{SomeFormatter( ...Formatter_Specific_Args=XX... head=XXX foot=YYY cols=ZZZ colnames=XYZ style=ZXY}'''{BR}{BR}
'''Where:''' {BR}
* '''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'.''
{BR}
)))
{BR}

==== Add A Heading ====
(((
'''Markup:'''{BR}{BR}
'''{SomeFormatter( ... head='My Heading'}''' {BR}{BR}
'''Result:'''{BR}{BR}
{|  
|+ My Heading
! Col1 !! Col2  
|-  
| DataCell1 || DataCell2
|}
)))
{BR}

==== Add A Footer ====
(((
'''Markup:'''{BR}{BR}
'''{SomeFormatter( ... foot='My Footer'}''' {BR}{BR}
'''Result:'''{BR}{BR}
{|  
! Col1 !! Col2  
|-  
| DataCell1 || DataCell2
|}
)))
{BR}

==== Change Column Order and Display ====
(((
'''Markup:'''{BR}{BR}
'''{SomeFormatter( ... cols='Col1,Col3,Col2'}''' {BR}{BR}
'''Result:'''{BR}{BR}
{|  
|+
! Col1 !! Col3 !! Col2
|-  
| DataCell1 || DataCell3 || DataCell2
|}
{BR}
''Here a 4 column called Col4 is omitted since it is not mentioned.''
)))
{BR}

==== Change Column Names ====
(((
'''Markup:'''{BR}{BR}
'''{SomeFormatter( ... colnames='X,Y,Z'}''' {BR}{BR}
'''Result:'''{BR}{BR}
{|  
|+
! X !! Y !! Z
|-  
| DataCell1 || DataCell2 || DataCell3
|}
)))

'''OR'''

(((
'''Markup:'''{BR}{BR}
'''{SomeFormatter( ... cols='Col1,Col3,Col2' colnames='X,Y,Z'}''' {BR}{BR}
'''Result:'''{BR}{BR}
{|  
|+
! X !! Y !! Z
|-  
| DataCell1 || DataCell3 || DataCell2
|}
)))
{BR}

==== Styling ====
{BR}
(((
'''Markup:'''{BR}{BR}
'''{SomeFormatter( ... style='generic'}''' {BR}{BR}
)))
{BR}
If the style argument is not supplied the default wiki table style is used.{BR}
There are 2 theme based styles and 11 predefined styles which are bundled with all the formatters (which uses tables).{BR}{BR}
'''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:'''{BR}

[file:{UP(Customize.CategoryListFormatter)}TableStyle.css|/Keeper.Garrett.Formatters/Tables/TableStyle.css] {BR}

'''So to create your own custom style simply add your CSS to this file.'''
{BR}

===== Examples =====
[image||{UP(Customize.CategoryListFormatter)}Style1.png]{BR}
[image||{UP(Customize.CategoryListFormatter)}Style2.png]{BR}
[image||{UP(Customize.CategoryListFormatter)}Style3.png]{BR}
{BR}
Meta Keywords: CategoryList, Formatter
Meta Description: View pages in a category as list or tables, across namespaces
Change Comment:
CategoryListFormatter Plugin

Side Projects¶

About¶
