NOTICE: This extensions is now available for Joomla 1.5, Joomla 2.5 and Joomla 3.0
Screenshots
Examples
If the following was set in the RokCandy configuration:
[example title={title}]{text}[/example] it would output the following code:
<div class="example">
<h3>Title</h3>
<p>Some content</p>
</div>
That is a simple example, but the degree of sophistication is limited by your own creativity. A more complex example be can seen below:
<div class="complex">
<div class="tl">
<div class="tr">
<div class="bl">
<div class="br">
<div class="header">
<h3 class="title">Title</h3>
<span class="subheader">Lorem ipsum dolor sit amet, consectetur adipiscing elit. Donec sit amet nibh. Vivamus non arcu.</span>
</div>
<div class="content">
<p>Lorem ipsum dolor sit amet, consectetur adipiscing elit. Donec sit amet nibh. Vivamus non arcu. Lorem ipsum dolor sit amet, consectetur adipiscing elit.</p>
<img src="/images/stories/image1.jpg" alt-"Image" class="image"/><br />
</div>
</div>
</div>
</div>
</div>
</div>
The above example could be styled to be an expandable, 4 rounded corners element which distinct styling for the header and content divisions. As you can see, it is a complex setup via HTML to implement, and even more difficult if you have an illiterate client or content editors are in play. The following syntax could be used [complex title={title} subheader={subheader} image={image}]{text}[/complex] which is clearly simpler and easier to use.
Installation - Joomla 1.5
Downloading the Extension Files
- RokCandy Component (com_rokcandy.zip) This file is the component package you will use to install RokCandy into Joomla.
Using the Joomla Installer
From the Menu in your Joomla Administrator, go to Extensions → Install/Uninstall.
Next, browse for your com_rokcandy.zip file you downloaded and then click Upload File & Install.
Accessing the Component Page
Next, go to Components → RokCandy. You will be brought to the Macros page which lists all the current snippets, whether generated from the component defaults or from the template overrides.
How do I configure RokCandy, the Syntax?
RokCandy is distributed with default snippets for a variety of logical purposes such as for content title. However, Joomla 1.5 offers its templates the capacity to override the core of Joomla. In this manner, we can add files to the template that will override the snippets in RokCandy. Therefore, you can quickly add and edit your own macros without modifying core files.
The file is called
default.ini and, if you are using a RocketTheme template which uses RokCandy, it will be located in the
/templates/rt_TEMPLATE_NAME_j15/html/com_rokcandy/ directory. However, if the folder does not exist, you will have to create the necessary folders as shown in the path above and create a new file named
default.ini.
Also, you can also add and control your own in the Administrator:
Components → RokCandy. They will appear in the following format:-
[tag]{text}[/tag]=<tag>{text}</tag>
Such as
[alert]{text}[/alert]=<span class="alert">{text}</span>
As is apparent, each line is separated into distinctive sections. There are two parts, the RokCandy syntax (left of =) and the outputted HTML (right of =). You would create your own tag name and insert them between square brackets, [], followed by {text} and the closing tag with [] brackets again. This segment is followed by the
= symbol and following on from that is the HTML output. Note, the {text} is required in both parts to denote what element is to be carried forward. You can use any value between the {} brackets, such as {title} or {link} as long as they are cross referenced in the HTML output as shown in the example below:-
[box title={title} link={link}]{text}[/box]=<div class="box"><h3><a href="/{link}">{title}</a></h3><p>{text}</p></div>
Note, the best way to understand the syntax rules is to look at the default.ini file and see what syntax we use.
Changelog
This is the changelog for the RokCandy Component inclusive of alpha, beta, release candidate and final versions.
Joomla 2.5.x / Joomla 3.0.x
Legend:
* -> Security Fix
# -> Bug Fix
+ -> Addition
^ -> Change
- -> Removed
! -> Note
------- 1.5.0 Release [01-Nov-2012] -------
# Fixed Button.png Not Found on Front-end Editor
# Fixed macro and html input too small
# Fixed Notice: Undefined variable
# Fixed strict standards in /models/candymacro.php
# Fixed strict standards in /com_rokcandy/controller.php
+ Joomla 3.0 Compatibility
------- 1.4 Release [04-Sept-2012] -------
# Fixed strict references
# Fixed installer
# Code cleanup
----------- 1.3 Release [04-Feb-2012] -----------
# tinyMCE.getContent is not a function
----------- 1.2 Release [16-Dec-2011] -----------
# RokCandy editor button is making problem with Articles editor button
# Update RokCandy Language Strings in 1.7 version
# Update all file headers to match
# Help Button not displaying Help Page
# Ensure that frontend is updated to work with new backend
# submenu not showing on categories view
# edit view not saving html tags entered in html or macro fields
# global cofif language strings are missing
# extra tip missing in macro edit screen
# Create new model view for J1.7 for the rokcandy xtd-editor plugin
# fix installer
# fix admin menu images
# uninstalling rokcandy component crashes frontend and backend
# template overrides macros cant be selected
# Update J1.7 version to J1.7 native MVC
# Switch install data over to SQL sample file
# Update rokcandy system plugin to accomidate new model
----------- 1.1 Release [13-Jun-2011] -----------
# Fixed a JS error when using RokPad
----------- 1.0 Release [02-Mar-2011] ----------
! Initial Release
Joomla 1.5.x
Legend:
* -> Security Fix
# -> Bug Fix
+ -> Addition
^ -> Change
- -> Removed
! -> Note
----------- 1.3 Release [25-Aug-2010] ----------
25-Aug-2010 Juozas Kaziukenas
# Fixed issue with textarea ID detection
----------- 1.2 Release [27-Apr-2010] ----------
27-Apr-2010 Brian Towles
# Fixed for self closing tags
----------- 1.1 Release [06-Mar-2010] ----------
06-Mar-2010 Brian Towles
# Fixed segfault for early non unicode PCRE libraries.
----------- 1.0 Release [04-Feb-2010] ----------
04-Feb-2010 Brian Towles
# Fixed issue with missing macros should fail quiet now
# Fixed bad tokens
----------- 0.88a Release [06-Nov-2009] ----------
06-Nov-2009 Brian Towles
# Changed the newline handling for regular expressions.
----------- 0.87a Release [29-Oct-2009] ----------
29-Oct-2009 Brian Towles
# Fixed some backwards compat regular expressions
----------- 0.86a Release [06-Oct-2009] ----------
06-Oct-2009 Brian Towles
# Added better javascript handling to fix issues with Community Builder and more.
----------- 0.85a Release [29-Aug-2009] ----------
29-Aug-2009 Brian Towles
# Fixed to search for nested instances of tags to prevent javascript expansion
# Fixed non-default value for argument for onPrepareContent
# Fixed bug in disabled overrides
----------- 0.84a Release [11-Jun-2009] ----------
11-Jun-2009 Andy Miller
+ Fixed problem with error on PDF view
----------- 0.83a Release [16-Apr-2009] ----------
16-Apr-2009 Andy Miller
+ Added onPrepareContent Trigger for rokcandy in content items
----------- 0.82a Release [02-Feb-2009] ----------
02-Feb-2009 Andy Miller
+ Added Frontend editor button support
+ Added custom disable ability, ie for community builder profiles
# Fixed filtering of certain HTML tags (eg script, iframe, etc)
# Fixed ability to leave macro variables empty between quotes
----------- 0.81a Release [02-Feb-2009] ----------
02-Feb-2009 Andy Miller
# Added PHP4 compatibility fix
----------- 0.8a Release [28-Jan-2009] ----------
28-Jan-2009 Andy Miller
! Initial Release
----------- Initial Changelog Creation -----------
