Welcome Guest, you are in: Login

Search:

download
Version2.0.1.0
Rating  
DeveloperChristian Hollerup Mikkelsen
Updated2016-01-09
Homepagehttp://master-garrett.blogspot.com/
Works withScrewTurn Wiki v5.0.x
LicenseGPLv2
Supported languages-
Visual-editorno

Autogenerates a list/table of files in a directory chosen by the user, either for download or simple file overview.


Table of Contents [Hide/Show]


    Administrators
    Markup Usage
       Minimum
    Tables and Styling
       Markup Usage
       Add A Heading
       Add A Footer
       Change Column Order and Display
       Change Column Names
       Styling
          Examples



Administrators

No special actions required.

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 list/table of files in a directory that match a certain pattern
  • Specify specific File Storage Provider to find files in
  • Enable/disable ability to download the files
  • Sort the files asc/desc accoring to:
    • Name
    • Size
    • Last modified date
    • Download count
  • Display details of the files:
    • Size
    • Last modified date
    • Download count




Usage:


{ FileList file= prov= type= dwnl= details= sort= }


Where:

  • file - A valid path and file wildcard
    • All patterns must start with '/' ex.  /*.*, will give all files in the root dir of the provider
    • For sub directories:  /MyDir/*.* will work
      • Default dir if none specified is '/'
    • For file wildcards: *.* , Screw*Wiki.*xe, *.zip etc. will work
    • Default wildcard is *.* if none is specified
    • Note that the definition of the default dir might differ from provider to provider, ex. for Local Files Provider, the default root is /public/Upload
  • prov - Fullname as seen in the wiki File management, ex. 'Local Files Provider' and 'SQL Server Files Storage Provider', must be encapsulated in ' '
    • Default value is the chosen wiki default file storage provider
    • Note that the definition of the default dir might differ from provider to provider, ex. for Local Files Provider, the default root is /public/Upload
  • type - Can be one of: *,# or 'table'
    • "*"- Means unnumbered list
    • "#"- Means numbered list
    • "table" - Means use table instead of list
    • Default is *
  • dwnl - Should filenames displayed as download links, true or false, default is false
  • sort - Can be anything of the following 4, but must be follow by either asc or desc for direction and seperated by ','
    • name- Filename
    • size- File size
    • date- Last modified date
    • Default is date,desc
  • details - Details to show about each file. Can be any combination of the following 4 seperated by ','
    • name- Filename
    • size- File size
    • date- Last modified date
    • Default is none



All args which have a value that contains whitespaces, must be encapsulated in ' ', ex. 'Local Storage Provider'. 



Minimum



Markup:


{ FileList file='/*.*'}


Result:


  • File1
  • File2
  • File3



Markup:


{ FileList file='/*.*' type=# }


Result:


1. File1

2. File2

3. File3




Markup:


{ FileList file='/*.*' dwnl=true }


Result:





Markup:


{ FileList file='/*.*' sort='date,desc' dwnl=true }


Result:





Markup:


{ FileListfile='/*.*' sort='date,desc' dwnl=true details='date,size' }


Result:





Markup:


{ FileListfile='/*.*' sort='date,asc' dwnl=true details='date,size' }


Result:





Markup:


{ FileListfile='/*.*' sort='downloads,asc' dwnl=true details='date,size' }


Result:





Tables and Styling

The Keeper Garrett Screwturn Formatters currently consists of 4 formatters which all uses the same tables and styling scheme, they are:





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
Col1Col2  
DataCell1DataCell2




Add A Footer


Markup:


{SomeFormatter( ... foot='My Footer'}


Result:


Col1Col2  
DataCell1DataCell2




Change Column Order and Display


Markup:


{SomeFormatter( ... cols='Col1,Col3,Col2'}


Result:


Col1Col3Col2
DataCell1DataCell3DataCell2


Here a 4 column called Col4 is omitted since it is not mentioned.



Change Column Names


Markup:


{SomeFormatter( ... colnames='X,Y,Z'}


Result:


XYZ
DataCell1DataCell2DataCell3


OR


Markup:


{SomeFormatter( ... cols='Col1,Col3,Col2' colnames='X,Y,Z'}


Result:


XYZ
DataCell1DataCell3DataCell2




Styling



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:
  1. No style specified - will use the current theme's default style
  2. generic - will use the current theme's generic style
    1. 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:
  1. hor-minimalist-a
  2. hor-minimalist-b
  3. ver-minimalist
  4. box-table-a
  5. box-table-b
  6. hor-zebra
  7. hor-zebra-a
  8. hor-zebra-b
  9. rounded-corner
  10. background-image
  11. 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

Image

Image

Image



 
  Name Size
- Garrett.png 27.79 KB
- Style1.png 19.58 KB
- Style2.png 30.79 KB
- Style3.png 28.36 KB
- TableStyle.css 14.43 KB

Side Projects

  • RESX Synchronizer allows to synchronize multi-language .resx files (used for the development of ScrewTurn Wiki).
  • Pixel Picker enables to pick the color of pixels on your screen — very handy for day-to-day graphics-related activities.

About