Jump to content
joshuag

Recurme – Processwire Recurring Dates Field & Custom Calendar Module.

Recommended Posts

Introducing our newest [commercial] module:

Recurme
Processwire Recurring Dates Field & Custom Calendar Module.

http://www.99lime.com/modules/recurme/

One Field to Recur them ALL…
A Recurring Dates InputField for your Processwire templates. The InputField you’ve been waiting for.
Complex RRule date repeating in a simple and fast user interface.

Use the super simple, & powerful API to output them into your templates.

example:

<?
	// easy to get recurring events
	$events = $recurme->find();
	// events for this day
	$events = $recurme->day();
	// events for this week
	$events = $recurme->week();
	// events for this month
	$events = $recurme->month();
?>
<?
	// Loop through your events
	foreach($events as $event){
		echo $event->title;
		echo $event->start_date;
		echo $event->rrule;
		echo $event->original->url;
		...
	}
?>

Unlimited Custom Calendars.
Imagine you could create any calendar you wanted on your website. Use recurring events with the Recurme field, or use your own Processwire pages and date fields to render calendars… it’s up to you. Fully customizable. Make as many calendars as you like. Get events from anywhere. Recurme does all the hard date work for you.

Unlimited Custom Admin Calendars too.

Hope you like it :) ,

 Joshua & Eduardo from 99Lime.

 

ss-recurme.png

Unknown.png

ss-admin1.png

ss-recurme5.png

ss-admin5.thumb.png.434d6cd178d8fab47f3efa4e3437f604.png

 

## [1.0.1] - 2017-05-29
### changed
- Fixed $options[weekStartDay] offset in Calendar
- Fixed ->renderCalendar() Blank Days
- Fixed missing ->renderList() [renderMonth][xAfter]
- Removed ->renderCalendar() <table> attributes border, border-spacing
- Fixed ->renderCalendar() excluded dates
- Fixed rrule-giu.js exclude dates
- Fixed ->renderList missing space in attr ID
(shout out to @Juergen for multiple suggestions & feedback).

  • Like 28

Share this post


Link to post
Share on other sites

Wow, this looks amazing! I've been wishing someone would make a full-featured PW calendar module for a while now and this looks like it fits the bill. So thanks! :)

A question: it looks like it's possible to disable an occurrence of an event, but is it possible to create a one-off variation of an occurrence? For example, if there is a weekly yoga class on a Tuesday but on one particular week it has to move to Wednesday, can I locate that occurrence and edit it individually? Similar to this, from Lightning calendar...

2017-05-20_125245.png.8ec96d1912393353f600b311fd99c5e1.png

 

P.S. the links on the 99lime.com home page to "Responsive Menu" and "ProcessWire Go" are non-functional.

  • Like 1

Share this post


Link to post
Share on other sites

Hi Robin,

Thanks for your kind words. 

To answer your question, no there is no "edit this occurance" button... although we have gone back and forth on that one for a while. However, you can still get the desired effect by duplicating your event for just that special instance and removing the occurance from the original. You basically are just doing the job of the "edit this occurance" button manually. 

The next release of Recurme will include selecting multiple additional dates to add to a recurrence. That will also solve your needs nicely. :)

Hope that makes sense. 

Happy coding. 

  • Like 2

Share this post


Link to post
Share on other sites

great job!

i already did a calendar using https://fullcalendar.io/ but without recurring events (thats a lot more difficult do implement and i see you also had to set a hard max of 2800 so far...). i guess you can count me to your customers before end of may ;)

1) is the calendar custom css? can it easily be adopted to other styles/themes?

2) is there drag&drop support for events? i build this on fullcalendar+pw. but it's not a must have...

  • Like 1

Share this post


Link to post
Share on other sites

Hi bernhard, 

Super easy to style via CSS or override any CSS you want. All interactions are CSS animations or transitions as well. Or use custom HTML. Also, no need to use the built in calendar. You could easily use recurring events with fullcalendar using the event API. No drag and drop support on the recurme calendar. The calendar is more for displaying your events than managing them... although it has modal window event editing. 

We have a solution in the works for beating the 2800 limit we set. Hope to get that out in the next couple updates. 

Happy coding!

Share this post


Link to post
Share on other sites

Looks really amazing.

One question: Is there the possibility to limit an event to a certain endtime or to a certain date? Fe event starts at 6am and ends at 9am or an event goes over midnight (multiple days event)

From the images above it seems that it will always be a whole day event.

Best regards and respect for this work.

  • Like 1

Share this post


Link to post
Share on other sites

@Juergen Currently, you can set the event start date and hour, but there is no end time field for a specific event. You can add an end_time field to your event (or whatever it's called) template if you wanted to output that it starts at 6pm and ends at 9pm, for example. 

 There are no facilities for spanning multiple days with a single event. In most cases such as a 3 day event, we just repeat the event for those 3 days in a row so that it displays on the calendar for the 3 consecutive days. Then In our event template we create a description field to describe the exact details of the event.

You can add any fields you want to your template. 

With a little custom CSS for your event, you could make it very clear that it's a unified event that spans more than one day  

I am very interested in coming up with a way to include spanning multiple days with the recurme interface in an easy to use format, but for now, repeating the event has covered our use cases pretty well. Maybe that would work for you. 

Share this post


Link to post
Share on other sites

Only just a thought:

It would make more sense to offer only the possibillity to enter just a start date without a time. If there is a start time, there should also be an endtime. So if you remove the time setting from the inputfield for the date it means there is an event on that date which is all day long.

If there is a need to restrict an event via a start and end time we can add 2 PW time fields to the template. This is the case if there is fe a course the starts and ends at a certain time. This looks better than using the time field from the module field for the starting time and another time field from another PW field type for the endtime (2 different fieldtypes with different looks).

Another case would be that a store is fe closed on that day (inventory or something else). The shop is closed the whole day. So there is no need to enter a start time - it is an all day event. We dont need a start time in this case.

Conclusion: I think a date only field without the possibility to add the time would be a better fitting solution in this case. If you want you can add 2 time fields to the template or not (depending on your needs). No mixin of 2 different fields necessary.

Best regards

 

 

  • Like 1

Share this post


Link to post
Share on other sites

Is modifying the recurring tabular list below the RRule definition currently the only way to exclude dates in the exclusion? We pay for a (rather poorly implemented) calendar that has a GUI mini-calendar selection to create a list of dates to exclude. Love this calendar, but I'd be fearful of removing/changing something that our staff (not highly computer literate) is used to - so just curious.

Thanks for providing this! RRule is a confusing thing to implement in a database!

  • Like 1

Share this post


Link to post
Share on other sites

Yes, currently it is the only way. I dislike how it is currently refreshing the whole recurme field when a date is excluded. Something that I have on my list to improve. Even so, we have had really good success with our users (clients) excluding dates this way.

Have you tried the live example of the Recurme field on the website? 
http://www.99lime.com/modules/recurme/iframe-demo/

Now, you have given me a new idea for handling exclusions that I think could be more elegant. Thanks!

  • Like 1

Share this post


Link to post
Share on other sites

Hi @joshuag, I'm noticing strange behaviour when I create a recurring event.

For some reason the initial event occurs on the start date, but then another event is added the following day and all the recurrences are based on that second event. See the screenshots below where the intial event is set for a Tuesday and to recur every 7 days but the events recur on a Wednesday.

2017-05-28_163749.thumb.png.5ed2b8b59b183f9d18ededcf724c7bdd.png

2017-05-28_163849.thumb.png.24358704483663c55c18cbadc0151080.png

Share this post


Link to post
Share on other sites

Sorry, but I cannot confirm this behavior. Do you have set $config->timezone correctly in your config.php? In my case the dates will be calculated correctly.

Share this post


Link to post
Share on other sites

Here is a little Hook that I use to add the last date of recurring events to the end of publication field.

Please copy this piece of code into your ready.php file.

//dates = name of your recurring field - please change it to your field name
//publish_until = name of your end of publication field - please change it to your field name


// hook to add the publish_until date according to the last event date
$pages->addHookAfter('saveReady', function($event)
{
    $page = $event->arguments[0];
    if ($page->hasField('dates')) {
      $dates = $page->getDates(); 
      if($dates){    
      foreach($dates as $key=>$date){
         if ($key === key($dates))
        $enddateunformatted = $date;
      }
      $page->publish_until = $enddateunformatted;
      $enddateformatted = date('d-m-Y', $date);
      $this->message($this->_("The end date of the publication was set to {$enddateformatted}."));
      }
    }
});

In my case I use the the SchedulePagesModule to unpublish pages after a certain date. In this case the date field for unpublishing pages is called "publish_until". My recurme field in this case is called "dates". You have to add both fields to your template.

Now I want to copy the last date of the recurring events to the "publish_until" field, so that the article will be unpublished after the last recurrence.

For this purpose you have to add the code above to your ready.php file. If you have named the fields differently than "publish_until" and "dates" you have to replace this by your names.

In a first step I check if the template has the recurme field "dates". If yes then I check if there are events generated. The last step is to grab the last occurence and add this date to the end of the publication field ("publish_until") - finished!

After pressing the save button the last ocurrence date will be saved in the publish_until field and the article will be unpublished after this date.

Best regards

  • Like 6

Share this post


Link to post
Share on other sites

@Robin S  setting your $config->timezone should resolve this problem as mentioned. If not, let me know and I can take a look at your specific setup with you, just send me a pm. 

@Juergen that is a very cool trick! Thanks for sharing :)

Share this post


Link to post
Share on other sites
11 hours ago, joshuag said:

setting your $config->timezone should resolve this problem as mentioned

Yes, I have my timezone set correctly in config.

Not sure what caused that issue but after removing the Recurme field from the template, adding it back again and setting up the event again it is working normally now. So case closed for now, thanks. :)

Share this post


Link to post
Share on other sites

@Robin S thanks for letting us know. I will experiment And see if I can reproduce this behavior. 

Glad it's working correctly :)

  • Like 1

Share this post


Link to post
Share on other sites
On 5/24/2017 at 0:27 AM, Juergen said:

Only just a thought:

It would make more sense to offer only the possibillity to enter just a start date without a time. If there is a start time, there should also be an endtime. So if you remove the time setting from the inputfield for the date it means there is an event on that date which is all day long.

If there is a need to restrict an event via a start and end time we can add 2 PW time fields to the template. This is the case if there is fe a course the starts and ends at a certain time. This looks better than using the time field from the module field for the starting time and another time field from another PW field type for the endtime (2 different fieldtypes with different looks).

Another case would be that a store is fe closed on that day (inventory or something else). The shop is closed the whole day. So there is no need to enter a start time - it is an all day event. We dont need a start time in this case.

Conclusion: I think a date only field without the possibility to add the time would be a better fitting solution in this case. If you want you can add 2 time fields to the template or not (depending on your needs). No mixin of 2 different fields necessary.

Best regards

 

 

I agree with @Juergen on the start/end time input workflow with separate time input fields.

Would like to use this module for a room occupancy calendar. @joshuag Is it possible with your module to have multiple events for one day with start and end times that recur daily/weekly/monthly? E.g.
17.00 - 19.00 every Monday
19.00 - 21.00 twice a month on Mondays
etc.

  • Like 1

Share this post


Link to post
Share on other sites

hello @gebeer

it is possible to add as much dates as you want to one day (fe. 100 or more if you want). You only have to create one event (page) for each of your events and make them recurring to your needs. So from the module there are no restrictions. It also doesnt matter if the starting and ending time of several events are the same on the same day. On the calendar view only few events are displayed for this day (depending on the space in the calendar row - see next image on the 6th). All others will be overflown.

Screenshot_2.jpg.c1a707711ac4e46b408ed85e44f9e623.jpg

After hovering the calendar cell all events on that day will be displayed.

Screenshot_3.jpg.7bcbf8b105828b3088ed75ef56fbb298.jpg

If you are entering fe 100 events on that day (and I am sure you would probably not ;)) the list will be very long, but technically it would be possible.

There are a lot of recurrence possiblilities fe. the first and the last day of a month every second monday every month,.... take look at the documentation.

Jürgen

  • Like 4

Share this post


Link to post
Share on other sites

Hi @gebeer

like @Juergen said, you should have no problem doing what you need with Recurme. Perfect use case for this module :)

i am experimenting with an adjustment to the Recurme interface to account for all day events and time-end field. Hoping to release an update that addresses that need this week. 

  • Like 4

Share this post


Link to post
Share on other sites

@joshuag 

I wonder if there is a possibility to switch views in the frontend, say a weeks or days calendar instead of month and/or list?

Thanks

Share this post


Link to post
Share on other sites

You can realize this by creating own templates with the different views and call them via Ajax. There is no out of the box solution for this.

  • Like 1

Share this post


Link to post
Share on other sites

@totoff Great question. You could actually use Recurme with full calendar if you like. 

Example event object from full calendar: https://fullcalendar.io

$('#calendar').fullCalendar({
    events: [
        {
            title  : 'event1',
            start  : '2010-01-01'
        },
        {
            title  : 'event2',
            start  : '2010-01-05',
            end    : '2010-01-07'
        },
        {
            title  : 'event3',
            start  : '2010-01-09T12:30:00',
            allDay : false // will make the time show
        }
    ]
});

This would be easy to output with recurme using the API:

$FCEvents = array();
$events = $recurme->day();
foreach($events as $event){
	$FCEvents[] = array(
		'title' =>  $event->title,
		'start' => 	$event->start_date,
	);
}

Print your array as javascript. And use the built in views in full calendar. 

  • Like 3

Share this post


Link to post
Share on other sites

Works also with UiKit calendar and Bootstrap calendar if you are using a framwork. If you are using UiKit calendar you can make fe a template which outputs all the calendar dates in a json array. Then you can load this template (or lets say the event dates) via ajax into the UiKit calendar template engine. Its very easy.

  • Like 2

Share this post


Link to post
Share on other sites
14 hours ago, joshuag said:

Great question. You could actually use Recurme with full calendar if you like. 

actually, I set up a fullcalendar yesterday after my post here :-)

  • Like 1

Share this post


Link to post
Share on other sites

Join the conversation

You can post now and register later. If you have an account, sign in now to post with your account.

Guest
Reply to this topic...

×   Pasted as rich text.   Paste as plain text instead

  Only 75 emoji are allowed.

×   Your link has been automatically embedded.   Display as a link instead

×   Your previous content has been restored.   Clear editor

×   You cannot paste images directly. Upload or insert images from URL.


  • Recently Browsing   0 members

    No registered users viewing this page.

  • Similar Content

    • By dimitrios
      Hello,
      this module can publish content of a Processwire page on a Facebook page, triggered by saving the Processwire page.
      To set it up, configure the module with a Facebook app ID, secret and a Page ID. Following is additional configuration on Facebook for developers:
      Minimum Required Facebook App configuration:
      on Settings -> Basics, provide the App Domains, provide the Site URL, on Settings -> Advanced, set the API version (has been tested up to v3.3), add Product: Facebook Login, on Facebook Login -> Settings, set Client OAuth Login: Yes, set Web OAuth Login: Yes, set Enforce HTTPS: Yes, add "http://www.example.com/processwire/page/" to field Valid OAuth Redirect URIs. This module is configurable as follows:
      Templates: posts can take place only for pages with the defined templates. On/Off switch: specify a checkbox field that will not allow the post if checked. Specify a message and/or an image for the post.
      Usage
      edit the desired PW page and save; it will post right after the initial Facebook log in and permission granting. After that, an access token is kept.
       
      Download
      PW module directory: http://modules.processwire.com/modules/auto-fb-post/ Github: https://github.com/kastrind/AutoFbPost   Note: Facebook SDK for PHP is utilized.


    • By kongondo
      FieldtypeRuntimeMarkup and InputfieldRuntimeMarkup
       
      Modules Directory: http://modules.processwire.com/modules/fieldtype-runtime-markup/
      GitHub: https://github.com/kongondo/FieldtypeRuntimeMarkup
      As of 11 May 2019 ProcessWire versions earlier than 3.x are not supported
      This module allows for custom markup to be dynamically (PHP) generated and output within a page's edit screen (in Admin).
       
      The value for the fieldtype is generated at runtime. No data is saved in the database. The accompanying InputfieldRuntimeMarkup is only used to render/display the markup in the page edit screen.
       
      The field's value is accessible from the ProcessWire API in the frontend like any other field, i.e. it has access to $page and $pages.
       
      The module was commissioned/sponsored by @Valan. Although there's certainly other ways to achieve what this module does, it offers a dynamic and flexible alternative to generating your own markup in a page's edit screen whilst also allowing access to that markup in the frontend. Thanks Valan!
       
      Warning/Consideration
      Although access to ProcessWire's Fields' admin pages is only available to Superusers, this Fieldtype will evaluate and run the custom PHP Code entered and saved in the field's settings (Details tab). Utmost care should therefore be taken in making sure your code does not perform any CRUD operations!! (unless of course that's intentional) The value for this fieldtype is generated at runtime and thus no data is stored in the database. This means that you cannot directly query a RuntimeMarkup field from $pages->find(). Usage and API
       
      Backend
      Enter your custom PHP snippet in the Details tab of your field (it is RECOMMENDED though that you use wireRenderFile() instead. See example below). Your code can be as simple or as complicated as you want as long as in the end you return a value that is not an array or an object or anything other than a string/integer.
       
      FieldtypeRuntimeMarkup has access to $page (the current page being edited/viewed) and $pages. 
       
      A very simple example.
      return 'Hello'; Simple example.
      return $page->title; Simple example with markup.
      return '<h2>' . $page->title . '</h2>'; Another simple example with markup.
      $out = '<h1>hello '; $out .= $page->title; $out .= '</h1>'; return $out; A more advanced example.
      $p = $pages->get('/about-us/')->child('sort=random'); return '<p>' . $p->title . '</p>'; An even more complex example.
      $str =''; if($page->name == 'about-us') { $p = $page->children->last(); $str = "<h2><a href='{$p->url}'>{$p->title}</a></h2>"; } else { $str = "<h2><a href='{$page->url}'>{$page->title}</a></h2>"; } return $str; Rather than type your code directly in the Details tab of the field, it is highly recommended that you placed all your code in an external file and call that file using the core wireRenderFile() method. Taking this approach means you will be able to edit your code in your favourite text editor. It also means you will be able to type more text without having to scroll. Editing the file is also easier than editing the field. To use this approach, simply do:
      return wireRenderFile('name-of-file');// file will be in /site/templates/ If using ProcessWire 3.x, you will need to use namespace as follows:
      return ProcessWire\wireRenderFile('name-of-file'); How to access the value of RuntimeMarkup in the frontend (our field is called 'runtime_markup')
       
      Access the field on the current page (just like any other field)
      echo $page->runtime_markup; Access the field on another page
      echo $pages->get('/about-us/')->runtime_markup; Screenshots
       
      Backend
       

       

       
      Frontend
       

    • By kongondo
      Media Manager
       
      Released 31 March 2016
      https://processwireshop.pw/plugins/media-manager/
      Documentation 
      http://mediamanager.kongondo.com/
      As of 10 May 2019 ProcessWire versions earlier than 3.x are not supported
      *******************************************************   ORIGINAL POST   *******************************************************
      API Example (frontend; will be added to documentation site)
      Accessing and outputting the contents of the MediaManager field(s) in your template is quite simple. The fields are accessed like many other ProcessWire fields. The fields return an array of type MediaManagerArray that need to be looped to output each media within. Assuming you created a field of type MediaManager named 'media', you can loop through it for a given page as shown below.
        @note: Each MediaManager object has the following 5 basic properties:   DATABASE (saved properties) 1. id => pageID of the page where the media lives (hidden in admin and not important to know about) 2. type => integer denoting media type (1=audio; 2=document; 3=image [for variations this will be 3x, where x is the number of the variation of an original image]; 4=video)   RUNTIME 3. typeLabel => user friendly string denoting media type (audio, document, image, video) 4. media => a ProcessWire Image/File Object including all their properties (ext, filesizeStr, height, width, description, tags, filename, basename, etc.) 5. title => title of media (@note: this is the title of the page where the media lives; may or may not be the same as the name of the media file itself). This can be used as a user-friendly name for your media $media = $page->media;// returns a MediaManagerArray. Needs to be looped through foreach ($media as $m) { echo $m->id;// e.g. 1234 (hidden page in /admin/media-manager/media-parent/) echo $m->type;// e.g. 3 (a media of type image) OR 1 (a media of type audio) echo $m->typeLabel;// e.g. 'document' (i.e. type would be 2) echo $m->title;// e.g. 'My Nice Trip' (whose media file could be my-nice-trip.mp4) /* @note: - $m->media returns an object; either a ProcessWire Image (for image media) or File object (for audio, document and video media) - This means you have access to all the properties of that object, e.g. ext, tags, description, url, filename, basename, width, height, modified, created, filesize, filesizeStr, etc as well as associated methods, e.g. size() */ echo $m->media->tags; } // only output images foreach ($media as $m) { if($m->typeLabel =='image') { echo "<img src='" . $m->media->size(100,75)->url . "'><br>"; } } // There's also a toString() method so you can do: echo $page->media; /* All your media will be output wrapped in appropriate HTML tags, i.e.: audio: <audio></audio>; document: <a></a>; image: <img>; video: <video></video>; */  
      *******************************************************   ORIGINAL POST   *******************************************************
       
      The topic of a central media manager feature for ProcessWire has come up several times:
       
      https://processwire.com/talk/topic/4330-get-image-from-other-pages-via-images-field/
      https://processwire.com/talk/topic/4330-get-image-from-other-pages-via-images-field/?p=42578
      https://processwire.com/talk/topic/4330-get-image-from-other-pages-via-images-field/?p=42582
      https://processwire.com/talk/topic/425-file-manager/
      https://processwire.com/talk/topic/425-file-manager/?p=13802
      https://processwire.com/talk/topic/425-file-manager/?p=13861
      https://processwire.com/talk/topic/10763-asset-manager-asset-selector/
       
      More recently, regarding my Visual Page Selector module, I have been asked several times why the module does not have an in-built feature to upload images.
       
      There's two camps on the topic of a central media manager: those who like them (especially those coming in to PW from other CMSes) and those who don't like them (primarily because of the chaotic way some CMSes (dis)organise their media management) . I think that we can have our cake and eat it too! If done the right way, closely following the principles of and harnessing the power of ProcessWire, we can have a well-implemented, organised, feature-rich, site-wide media manager.
       
      Introducing Media Manager: (a commercial module)
       
      Alongside a number of modules I am currently working on (both free and commercial), I have been developing  a centralised Media Manager for ProcessWire. Before you cast the first stone, no, this is not going to be a one-large-media-bucket as in other CMS where it gets very messy very quickly . In the backend things are neatly stored away, yes, in pages. However, those are pages you will not see (just like repeater pages). Before anyone has a go at pages, remember a page is not that thing you see on the ProcessWire Tree (that's just its visual representation); A page is a record/row in the database    . For the end-user of Media Manager, all they will see is the 'familiar media bucket' to select their media from. As long as it works efficiently, I don't think they care about the wizardry behind the scenes  . 
       
      The module allows for the comprehensive management of several media types:
      Audio Video Images Documents Each media type will be handled by its own sub-module so the user can pick and install/choose the type of media management they want.
       
      Features include:
      Access controls Centralized uploads of media Bulk management of media: tag, delete, describe, replace, etc. Bulk upload: zip; scan, single Quick upload in page edit mode Usage stats across pages (maybe?) Etc.. Would love to hear your thoughts and any feature suggestions. I think there's enough demand for such a module. If not, please let me know so that I can instead focus on other things  , thanks.
       
      How other CMS do it

       
      The more efficient (PW) way of doing it

    • By Robin S
      I have had this module sitting in a 95% complete state for a while now and have finally made the push to get it out there. Thanks to @teppo for his Hanna Code Helper module which I referred to and borrowed from during development.
      http://modules.processwire.com/modules/hanna-code-dialog/
      https://github.com/Toutouwai/HannaCodeDialog
      HannaCodeDialog
      A module for ProcessWire CMS/CMF. Provides a number of enhancements for working with Hanna Code tags in CKEditor. The main enhancement is that Hanna tags in a CKEditor field may be double-clicked to edit their attributes using core ProcessWire inputfields in a modal dialog.
      Requires the Hanna Code module.
      Installation
      Install the HannaCodeDialog module using any of the normal methods.
      For any CKEditor field where you want the "Insert Hanna tag" dropdown menu to appear in the CKEditor toolbar, visit the field settings and add "HannaDropdown" to the "CKEditor Toolbar" settings field.
      Module configuration
      Visit the module configuration screen to set any of the following:
      Exclude prefix: Hanna tags named with this prefix will not appear in the CKEditor toolbar dropdown menu for Hanna tag insertion. Exclude Hanna tags: Hanna tags selected here will not appear in the CKEditor toolbar dropdown menu for Hanna tag insertion. Background colour of tag widgets: you can customise the background colour used for Hanna tags in CKEditor if you like. Dialog width: in pixels Dialog height: in pixels Features
      Insert tag from toolbar dropdown menu
      Place the cursor in the CKEditor window where you want to insert your Hanna tag, then select the tag from the "Insert Hanna tag" dropdown.

      Advanced: if you want to control which tags appear in the dropdown on particular pages or templates you can hook HannaCodeDialog::getDropdownTags. See the forum support thread for examples .
      Edit tag attributes in modal dialog
      Insert a tag using the dropdown or double-click an existing tag in the CKEditor window to edit the tag attributes in a modal dialog.

      Tags are widgets
      Hanna tags that have been inserted in a CKEditor window are "widgets" - they have a background colour for easy identification, are protected from accidental editing, and can be moved within the text by drag-and-drop.
      ![Hanna tag widget]
      Options for tag attributes may be defined
      You can define options for a tag attribute so that editors must choose an option rather than type text. This is useful for when only certain strings are valid for an attribute and also has the benefit of avoiding typos.
      Add a new attribute for the Hanna tag, named the same as the existing attribute you want to add options for, followed by "__options". The options themselves are defined as a string, using a pipe character as a delimiter between options. Example for an existing attribute named "vegetables":
      vegetables__options=Spinach|Pumpkin|Celery|Tomato|Brussels Sprout|Potato You can define a default for an attribute as normal. Use a pipe delimiter if defining multiple options as the default, for example:
      vegetables=Tomato|Potato Dynamic options
      Besides defining static options as above, you can use one Hanna tag to dynamically generate options for another. For instance, you could create a Hanna tag that generates options based on images that have been uploaded to the page, or the titles of children of the page.
      Your Hanna tag that generates the options should echo a string of options delimited by pipe characters (i.e. the same format as a static options string).
      You will probably want to name the Hanna tag that generates the options so that it starts with an underscore (or whatever prefix you have configured as the "exclude" prefix in the module config), to avoid it appearing as an insertable tag in the HannaCodeDialog dropdown menu.
      Example for an existing attribute named "image":
      image__options=[[_images_on_page]] And the code for the _images_on_page tag:
      <?php $image_names = array(); $image_fields = $page->fields->find('type=FieldtypeImage')->explode('name'); foreach($image_fields as $image_field) { $image_names = array_unique( array_merge($image_names, $page->$image_field->explode('name') ) ); } echo implode('|', $image_names); Advanced: define or manipulate options in a hook
      You can hook HannaCodeDialog::prepareOptions to define or manipulate options for a Hanna tag attribute. Your Hanna tag must include a someattribute__options attribute in order for the hook to fire. The prepareOptions method receives the following arguments that can be used in your hook:
      options_string Any existing string of options you have set for the attribute attribute_name The name of the attribute the options are for tag_name The name of the Hanna tag page The page being edited If you hook after HannaCodeDialog::prepareOptions then your hook should set $event->return to an array of option values, or an associative array in the form of $value => $label.
      Choice of inputfield for attribute
      You can choose the inputfield that is used for an attribute in the dialog.
      For text attributes the supported inputfields are text (this is the default inputfield for text attributes so it isn't necessary to specify it if you want it) and textarea. Note: any manual line breaks inside a textarea are removed because these will break the CKEditor tag widget.
      Inputfields that support the selection of a single option are select (this is the default inputfield for attributes with options so it isn't necessary to specify it if you want it) and radios.
      Inputfields that support the selection of multiple options are selectmultiple, asmselect and checkboxes.
      You can also specify a checkbox inputfield - this is not for attributes with defined options but will limit an attribute to an integer value of 1 or 0.
      The names of the inputfield types are case-insensitive.
      Example for an existing attribute named "vegetables":
      vegetables__type=asmselect Descriptions and notes for inputfields
      You can add a description or notes to an attribute and these will be displayed in the dialog.
      Example for an existing attribute named "vegetables":
      vegetables__description=Please select vegetables for your soup. vegetables__notes=Pumpkin and celery is a delicious combination. Notes
      When creating or editing a Hanna tag you can view a basic cheatsheet outlining the HannaCodeDialog features relating to attributes below the "Attributes" config inputfield.
      Troubleshooting
      HannaCodeDialog includes and automatically loads the third-party CKEditor plugins Line Utilities and Widget. If you have added these plugins to your CKEditor field already for some purpose and experience problems with HannaCodeDialog try deactivating those plugins from the CKEditor field settings.
×
×
  • Create New...