Documentation is a little scant at the moment, more will follow. Please have a look at the source, most things should be pretty clear.SetupExtract the files from the download to somewhere on your server. For simplicities sake, we are going to assume that you have extracted the files to /trickyInc/ It is essentially ready to use at this point.
Files / Directory StructureWill look like this: /trickyInc ../css ..../cache ..../constants ..../filters ..../includes ....index.php ../js ..../cache ..../constants ..../filters ..../includes ....index.php ..trickyInc.php
- trickyInc is the folder you extracted it into.
- trickyInc.php is the file containing the trickyInc class. It is important to note that the relative location of trickyInc.php is not important, it can be anywhere, so long as it can be included
- the css and js folders are just here for organization
- the index.php files include trickyInc.php and instantiate the class and tell it whether we are working with css or js. Please not that the location of the file that you instantiate the trickyInc class is important, it must be able to find the cache, constants, filters and includes folders at the same path
- the cache directory stores recorded output based on a specific query string / server path.
- the constants directory stores php files which provide trickyInc with sets of 'constatnts', that is key value pairs or string replacement within the content of included files
- the filters directory stores php files that contain classes to extend trickyInc so more advanced things with can be done to the included contents
- the includes directory contains css or js files to be used for final output.
More Details -
- Describes how to use trickyInc.
-
- Describes the includes directory, what includes are and how to use them.
-
- Describes the constants directory, what constants are and how to use them.
-
- Describes the filters directory, what filters are and how to use them.
-
- Describes the cache directory, and how caching works in trickyInc.
-
- Describes what browser conditionals are and how to use them.
-
- Describes what trickyImg is, and how to use it.
|