Fabrik User Manual 0



Yüklə 1,97 Mb.
Pdf görüntüsü
səhifə24/24
tarix17.09.2018
ölçüsü1,97 Mb.
#69275
1   ...   16   17   18   19   20   21   22   23   24

Timeline
The timeline visualization plots records on a time line. The top bar is a zoomed in view of
the timeline, whilst the bottom bar is a zoomed out view of the timeline. Scrolling either
will scroll the timeline.
Each event is plotted on the page and can be clicked on to show further information
about the event's record.
Data can be filtered, these settings are taken from the elements found in the fabrik
table's that are used to populate the timeline's data.
110


• Table - the fabrik table whose data will be plotted onto the timeline
• Start date - the element whose data contains the start date information. If
selected date elements don't have 'show time selector' activated then the
timeline shows the event spanning the whole day
• End date - the element whose data contains the end date. If left blank then the
event is presumed to last one day (if the start element's time options are turned
off) or to be a moment in time (if the start element's time options are turned on)
• Bubble template - This is the text that appears in a bubble when your users
click on an event which has been plotted on the timeline. Use place holders (e.g.
{tablename___elementname}) to include data from that event's record.
Create links to visualizations
To create a Joomla menu link to your visualization:
• Select "Menu->main menu" from the top administration menu.
• Then press the new button
• Next select "Fabrik->visualization"
• Give your link a name
• On the right hand side of the form select the visualization type you would like to
render.
• Then select the name of the visualization
Packages
We are still working on package, docs will be updated when we have some stable code to
document!
111


Scheduled Tasks
The schedule section allows you to define tasks that are repeatedly run at a give time
and interval.
For the schedule section to work you MUST have installed the
Fabrik schedule system
plug-in
.
Each scheduled task can be selected with the check box to the left of its name. Once
selected it can be altered by clicking on the buttons in the top right hand corner:
• Run - Force the scheduled task to run straight away.
• Published - sets the state of the scheduled task to published
• Unpublish - sets the scheduled task's state to unpublished
• Copy - copy's the scheduled task
• Delete - deletes the scheduled task
• Edit - edit the scheduled task, note that you can also edit the scheduled task by
clicking on its name
In the top right menu there is also the "New" button which allows you to create a new
scheduled task.
For each form in the list you have a link:
• Published - toggles the form's published state
112


Add/Edit a Scheduled Task
• Label - A descriptive name for the scheduled task
• Every - An integer value stating how often the task should be run
• Unit - Use in combination with the "Every" field to state how often the plug-in
should be run.
E.g. every 1 day
• Starting from - The date time at which the scheduled task should start to run
• Published - If not published the task is not run
• Connection - A Fabrik connection
• Table -select the table whose data you want to grab to run the scheduled plug-
in on. Its often a good idea to make a custom Fabrik table that is used solely by
the scheduled task
• Plugin - The plug-in that is run on the tables' data. Currently we supply only the
Email plug-in
Email plugin
Will iterate over each table record and send an email out per record.
• Eval- Evaluate the Message as PHP code
• To - Email address to send the notification to - can use the table's record's data
by using placeholders e.g. {tablename___elementname}
• Subject - The email subject - can use the table's record's data by using
placeholders e.g. {tablename___elementname}
113


• Message - The email subject - can use the table's record's data by using
placeholders e.g. {tablename___elementname}
Update
For each record parsed by the task you can set a fields value to a new value. This is
useful if you want to mark a record as having been parsed by the scheduled task.
• Field - the name of the field to update
• Value - the value to update the field to
114


Additional Joomla Plug-ins & Modules
As well as providing special plug-ins for the various features of Fabrik, we also provide
some standard Joomla modules and plug-ins. These can be found in fabrikar.com
downloads section.
Unlike Fabrik plug-ins these should be installed via Joomla's main extension installer:
• From the top menu select Extensions->Install/Uninstall
• Press the "browse" button
• Select the module or plug-in zip file that you want to install
• Press the "Upload Files & Install" button.
Modules
Modules provide you with the ability to display Fabrik forms and tables in your site's
module positions. We have two modules available one for forms and one for tables, they
can be seen in this image of the module manager (accessible via the top menu
extensions->modules):
115


Form module
• Title - The title that will appear at the top of the module
• Enabled - Is the module enabled on the site? If no then it will not be visible to
users
• Position - The module position in which you want the form to be render
• Order - Within the assigned module position, in what order should the module
appear
• Access Level - What access level is required by the user for the form to be
visible
Menus
• Menus - Which menu item's will display the module
• Menu Selection - If "select menu item(s) from the list" is selected for the
"Menus" option, then ctrl or shift click the menu items in which you want to show
the form
Parameters
• Module class suffix - A suffix to add to the module class name to allow specific
CSS styling
• Form id - The form id to render
• Row id - The row id to render -leave as zero to render a new form.
116


Table module
The Details and Menu assignment options are the same as the form module's options.
Parameters
• Module class suffix - A suffix to add to the module class name to allow specific
CSS styling
• Fabrik table id - The table id to render
• Use AJAX - If no selected and you click on a link in the module to add or edit a
record browser is redirected to a Fabrik component page showing this form. If
yes is selected Fabrik loads the form via Ajax and submission of the form takes
place via Ajax, meaning your browser rests on the current page.
• Randomize records - Randomize which records are shown from the table
• Number of records to show - An integer value specifying how many records to
show in the module's table
• Template - The template to use to render the module, if left blank this will
revert to the template selected for the table when creating it in Fabrik.
117


Plug-ins
Fabrik
The main Fabrik plug-in allows you to embed Fabrik content within your Joomla articles
The syntax for using the plug-in is written in the description field, and is duplicated
below for your convenience:
Forms
{fabrik view=form id=1} Will allow you to add a new record to a form whose id is 1
{fabrik view=form id=1 row=1} will let the user edit that form's row 1.
{fabrik view=details id=1 row=1} will show a read only view of that form's row 1.
Tables
{fabrik view=table id=1} to insert a table whose id id 1.
{fabrik view=form id=1 tablename___elementname=foobar} will filter the table to show
only records where 'elementname' has a value of 'foobar'
118


Visualisations
{fabrik view=visualization id=1} will show visualization id 1
Element data
{fabrik view=element table=11 rowid=239 element=element_test___checkbox} to
insert table 11 row 239's checkbox element's data
Common modifiers
For which ever view you choose you can change its template by adding
'layout=templatename'
Search System Plug-in
The search plug-in extends Joomla's standard search capabilities to enable your users to
search through your Fabrik table data.
Note that the access restrictions that you apply to the Fabrik table will also be applied to
the search results.
The edit plug-in page has the following options:
• Search limit - the maximum number of records to return in a search
• Section heading - the label that is used to describe the search results.
In addition you should be aware that you can exclude table data from the search results
by editing the desired table and in the "search" section in the "publishing" tab selecting
"no" for the "Include in search results" option.
This section also lets you define what data should be shown for the search results title
and description.
119


Scheduled Task System Plug-in
The scheduled task system plug-in has no parameters that need to be set except to
ensure that it is published.
This plug-in is required to be installed and published if you want to use Fabrik's
Scheduled Tasks
features.
Compatibility with 3rd Party Libraries
JACL +
Fabrik is fully compatible with JACL+. When installed, anywhere where Fabrik presents a
user group list, this list will show the groups created by JACL+
Joomfish
Fabrik provides some support for Joomfish, which should allow you to translate element
labels, form and table titles. Fabrik's content element files for Joomfish are located in
administrator/components/com_fabrik/contentelements
To enable a translation of the table data you will need to first go to tables->parameters
and turn on the "work in progress" option.
Then edit your table and turn on the 'Joomfish data translation' option.
Once you have saved your table a Joomfish xml file will be created for the table, allowing
you to translate its content from within the Joomlfish interface.
sh404SEF
A sh404SEF adaptor file can be found in the SVN in the folder components/com_fabrik/
sef_ext. This has not be fully tested by the Fabrik team, and should be taken as alpha
code (hence its exclusion from the current release zips)
Community Builder
We provide a Community builder plug-in which is capable of rendering all of Fabrik's
views (forms, tables and visualizations) It uses the same syntax as the
Fabirk Plug-in
Get the Fabrik CB plug-in from here:
http://fabrikar.com/index.php?option...d=54&Itemid=29
• Install it via community builders plug-in management page
• Make sure the plug-in is published
• Ensure that you have the Joomla Fabrik plug-in installed
• Go to community builders 'cb tab manager' page
120


• Edit the fabrik tab that should be there
• On the right hand side in the parameters section enter your Joomla plug-in text
to call Fabrik:
e.g.
{fabrik view=table id=11}
will load table 11
{fabrik view=table id=11 tablename___user={$my->id}}
will load table 11 filtered on the current user
(see the Joomla fabrik plug-in for a full list of options here, but basically you can show
any view that fabrik has (forms/visualizations/tables etc)
Joomsocial
We currently have an alpha Joomsocial plug-in available - see this forum thread for more
details:
http://fabrikar.com/forums/showthread.php?t=8934&highlight=joomsocial
Appendix
Common Joomla PHP coding tasks
Databases
The class that manages database operations can be found in
libraries/joomla/database/database/mysql.php
or
libraries/joomla/database/database/mysqli.php
They both have the same methods, but are written to make use of the mySQL and
mySQLi database types.
Load a single ROW of data as an object:
$db =& JFactory::getDBO();
$db->setQuery("SELECT `fieldA`, `fieldB` FROM `tablename` where `fieldC` =
'value'");
$row = $db->LoadRow();
121


Load a single VALUE from a ROW of data
$db =& JFactory::getDBO();
$db->setQuery("SELECT `fieldA` FROM `tablename` where `fieldC` = 'value'");
$fieldA = $db->LoadResult();
Load an array of rows as objects:
$db =& JFactory::getDBO();
$db->setQuery("SELECT `fieldA`, `fieldB` FROM `tablename` where `fieldC` =
'value'");
$rows = $db->loadObjectList();
Insert some data into a a database:
$db =& JFactory::getDBO();
$db->setQuery("INSERT INTO `tablename` (`fieldA`, `fieldB`) VALUES ('1', '2')");
$db->query();
122

Document Outline

  • License & Copyright
  • Suggestions Modifications and Corrections
  • Prerequisites
  • What's new in Fabrik 2.0?
  • Installation
  • Upgrading
  • Additional Help
    • What is Fabrik?
  • What is Fabrik?
    • Key Concepts
      • Placeholders
      • URL structure
    • Design strategy
  • Forms
    • Editing or Adding a Form
      • Basic settings
        • Details
        • Buttons
        • Form Processing
        •   Note
      • Form publishing
      • Groups
      • Templates
      • Options
        • CCK
      •  Submission plug-ins
        • Email Submission Plug-in
        • Receipt Submission Plug-in
        • Redirect Submission Plug-in
        • Run PHP
        • Run JS
    • Create a link to your form
    • Creating a search form
  • Groups
    • Editing or adding a group
      • Details
      • Pagination
  • Elements
    • Editing/Adding an Element
      • Details
      • Options
      • Publishing
        • RSS
        • Tips
    • Table settings tab
      • Filters
      • Table Column CSS
      • Calculations
    • Validations
      • Is alpha-numeric
      • Is email
      • Is not
      • Is Numeric
      • Is Unique
      • Not empty
      • PHP
      • Regular Expression
    • JavaScript
      • Setting Element Values With JavaScript
    • Element plug-ins
      • Button
      • Checkbox
      • Sub Elements
      • Add Options
      • Advanced
      • Database join
      • Add option in front end
      • Date
      • Display text
      • Drop down
      • Sub Elements
      • Options
      • Add Options
      • Field
      • File upload
      • Display
      • Thumbnail
      • Crop
      • Storage
      • ID
      • Image
      • Link
        • Bit.ly
      • Radio button
      • Sub Elements
      • Add Options
      • Text area
      • User
    • Additional Element Plug-ins
      • Timer
      • Youtube
      • Password
        • Form example
        • Administration options
      • CAPTCHA
        • Administration options
    • Subscriber Exclusive Element Plug-ins
      • Rating
        • Form example
        • Administration options
      • Google Map
        • Form Example
        • Administration settings
          • Options
          • Geocoding
          • Table settings
      • Cascading Drop down
        • Form example
        • Administration settings
          • Options
            • Advanced
            • Front end
      • Calculation
        • Administration settings
      • Colour Picker
        • Form example
        • Administration settings
      • Yesno
        • Form example
        • Table example
        • Administration settings
    • Parent / Child elements
  • Tables
    • Deleting a Table
    • Parameters
    • Importing a CSV file to create a new table
    • View details
    • Edit table
      • Details
      • Filters
      • Navigation
      • Layout
      • Notes
      • Advanced
      • Work in progress
      • The Publishing tab
        • RSS
        • CSV
        • Search
      • Access
      • Data Tab
        • Group by
        • Prefilter
        • Adding an additional prefilter
      • Joins
      • Related Data
    • Table Filters
      • Filtering via the query string
      • Prefilters
        • Get the records stored in the last 2 months:
        • Get the records for the upcoming week:
        • Display only the logged in users records:
      • Element Filters
      • Clearing filters
    • Table plug-ins
      • Copy plug-in
    • Create a link to you table
  • Connections
    • Add / Edit a Connection
  • Plug-ins
  • Visualizations
    • Add / Edit Visualization Standard Options
      • Details
      • Publishing
    • Plug-ins
      • Calendar
        • Data
        • Month View options
        • Anatomy of a Fabrik Calendar
        • Filtering
      • Chart
      • Map
        • Repeatable controls
        • Controls
        • Ajax Refresh
        • Clustering
        • Advanced
      • Timeline
      • Create links to visualizations
  • Packages
  • Scheduled Tasks
    • Add/Edit a Scheduled Task
      • Email plugin
      • Update
  • Additional Joomla Plug-ins & Modules
    • Modules
      • Form module
        • Menus
        • Parameters
      • Table module
        • Parameters
    • Plug-ins
      • Fabrik
        • Forms
        • Tables
        • Visualisations
        • Element data
        • Common modifiers
      • Search System Plug-in
      • Scheduled Task System Plug-in
  • Compatibility with 3rd Party Libraries
    • JACL +
    • Joomfish
    • sh404SEF
    • Community Builder
    • Joomsocial
  • Appendix
    • Common Joomla PHP coding tasks
      • Databases

Yüklə 1,97 Mb.

Dostları ilə paylaş:
1   ...   16   17   18   19   20   21   22   23   24




Verilənlər bazası müəlliflik hüququ ilə müdafiə olunur ©genderi.org 2024
rəhbərliyinə müraciət

    Ana səhifə