Installing the Abile Notes extension should be an easy task. From the extension manager, go to “Import extensions from online repository” and enter the key “abile_notes”. The extension will be registered as a frontend plugin. To insert it in a page content, create a new content in the page you want the extension to be, create a new content, select its type to “External plugin” and select the plugin as “Abile Notes”. Next is to define the page in which the notes will be stored. Set the “Startingpoint” to this page.
You can insert the extension from your template Tsconfig. This method present the advantage of having the extension available on every single page. To do so, the minimum required is to set the notesPid property to the page storing your note. The is achieve with the follogin code:
#my page id is 49:plugin.tx_abilenotes_pi1 { notesPid = 49 }lib.rightColumn < plugin.tx_abilenotes_pi1
You may control the display of the extension. This is achieved by overwriting the default TSconfig properties, overwriting the stylesheet or unseting the current one, and providing your own templates. Exemples of how you can overwrite the Tsconfig are presented in the Reference page.
Default Stylesheet:
The default stylesheet is located in the files “ext_typoscript_setup.txt”. You can unset the stylesheet and set your own with the follogin code in your TSconfig:
#unset the stylesheetplugin.tx_abilenotes_pi1._CSS_DEFAULT_STYLE >#set personal stylesheetpage.includeCSS { file1 = path/to/my/style.css}
Templates
The extension makes use of the Smarty template engine. This is a geat way to seprate the logic from the display. Furthermore, it aims at helping you to develop your very own templates. In order to so so, you must configure the location of the directory were you will prepare the templates. This is achieve through the “templatesDir” property. In this directory, you must create to new directories called “templates” and “templates_c”. In the new “templates” directory, you must insert the three templates “editScreen.tpl”, “listScreen.tpl” and “viewScreen.tpl”. The “templates_c” directory is used by Smarty as a cache folder and must be writable. You'll find the default templates at the root of the Abile Notes extension.
- Possible subsections: Reference (TypoScript)
Property: | Data type: | Description: | Default: |
|---|---|---|---|
allInOnePage | boolean | Wether or not we should display the list screen on top of every screens | 1 |
templatesDir | string | Location of the template and template_c Smarty templates | |
notesPid | integer | The page used to store the notes | |
listView.results_at_a_time | integer | Number of results to display | 5 |
listView.maxPages | integer | Number of pages to browse from. An odd value will be better displayed. | 5 |
listView.searchFieldList | string | The indexed fields to search from | content,title |
listView.orderByList | string | The database columns ordering the list | tstamp,title |
[tsref:tx_abilenotes_pi1]
Property: | Data type: | Description: | Default: |
|---|---|---|---|
templatesDir | string | Location of the template and template_c Smarty templates | |
listView.results_at_a_time | integer | Number of results to display | 5 |
listView.orderByList | string | The database columns ordering the list | tstamp,title |
[tsref:tx_abilenotes_pi2]
Minimum example
#my page id is 49:plugin.tx_abilenotes_pi1 { notesPid = 49 }lib.rightColumn < plugin.tx_abilenotes_pi1Full exemple
plugin.tx_abilenotes_pi1{ #top screen is the list, bottom screen is the note details allInOnePage = 1 #number of results to display listView.results_at_a_time = 4 #number of pages to browse from listView.maxPages = 5 #the indexed fields to search from listView.searchFieldList = content,title #the database columns ordering the list listView.orderByList = tstamp,title #location of the template and template_c Smarty templates templatesDir =}