Skip to content

Commit

Permalink
Clean readme, add note about minifying html
Browse files Browse the repository at this point in the history
  • Loading branch information
hailwood authored Jul 11, 2017
1 parent f86f698 commit bed056e
Showing 1 changed file with 17 additions and 13 deletions.
30 changes: 17 additions & 13 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,19 +20,19 @@ then browse to /dev/build?flush=all
Several of these helpers are disabled by default but can be enabled in the config.
#Requirements#
# Requirements
* Silverstripe 3.1+
* php5.4+
* php5-intl Package
#Extension Overview#
# Extension Overview
##DataListExtension##
## DataListExtension
- Adds a new *ListColumn* function to a DataList to allow implode() style functionality of the list items
e.g. `$list->ListColumn('ID', ' |')` would result in something like "1 |18 |19 |24".
- Automatically applied

##ExtraPageFieldsExtension##
## ExtraPageFieldsExtension
- Moves the metadata fields to a new tab
- Adds a new "Meta Title" field
- Automatically applied
Expand All @@ -58,31 +58,35 @@ class Page extends SiteTree {
}
}
````
##FooterMenuExtension##
```

## Relative Assets Extension
- Prefixes all references to `assets/*` with a preceeding slash i.e. they become something like `/assets/some.png`
- If [zaininnari/html-minifier](https://github.com/zaininnari/html-minifier) is installed minifies the HTML output before rendering.

## FooterMenuExtension
- Adds a new *ShowInFooter* option to the page settings
- Adds a new `FooterPages()` function to the SiteTree to return only pages that have this checked

##ImageExtension##
## ImageExtension
- Adds a new *Image Alt Text* option to the image settings
- Makes the image settings fields full width
- Automatically applied

##LinkExtension##
## LinkExtension
- Adds a new *SEO Text* option to the link settings
- Adds a *force download* checkbox to the link if it's set to a file.
- Automatically applied

#Template Providers Overview#
# Template Providers Overview

##HelpersTemplateProvider
## HelpersTemplateProvider
- Adds a new `Repeat($times)` function to the templates to return a loopable list (kind of like a for loop)
- Adds a new `Dump($obj)` function to the templates to allow easy dumping of any template variable

#Extendable Classes Overview#
# Extendable Classes Overview

##OwnerPermissionedDataObject##
## OwnerPermissionedDataObject
- Allows data objects to inherit the access permissions from their attached relation parent
- Relation parent defaults to `Page()`
- If `static::$relationOwner` is set to `null` will fall back to asking the standard `Page` for permission

0 comments on commit bed056e

Please sign in to comment.