Jump to content
ryan

Hanna Code

Recommended Posts

For efficiency reasons, Textformatter modules run from a single instance, so I'm guessing this is a side effect of that. I'll look into options for how we might get around the issue the next time I'm making updates to it. But assuming that 'body' is a rich text field and Hanna Code is the only Textformatter you had on it, you could probably get the unformatted version of it from your Hanna code and use that instead, to avoid triggering the circular reference (or whatever it's called). 

echo $child->getUnformatted('body'); 
  • Like 1

Share this post


Link to post
Share on other sites

right - should have thought of that, getUnformatted..  for now i just went with the template approach;

I was trying out ways to do more in the admin and less in the template code, as a means to eventually give the clients more flexibility;

Share this post


Link to post
Share on other sites

Realy nice this module.

I noticed when using the "Hanna Code Text Formatter" to output a field that has also "Hanna Code Text Formatter" you need to set Output Filtering to false at some point.

In my example i wanted to output the page title of multiple pages, while the page title itself also had the "Hanna Code Text Formatter" attached. Then it would show only the last title.

Edit: i just see that this is kinda what Ryan mentioned 2 posts before.

echo $child->getUnformatted('body'); 

The following works also, thats what i am using, but i suppose its the "same same, but different":

$child->of(false);
echo $child->body; 
  • Like 1

Share this post


Link to post
Share on other sites

How can you pass parameters to a selector in Hanna Code; for some reason i can't get it to work;

i have an attribute called "range" and then my hanna tag looks like this:

[[works range=<2000]]

which means my $range variable is <2000

the $workrange variable is then work_year<2000,

but the code doesn't work...

$workrange = "";
if($range) {$workrange = " work_year{$range}, "; }

$works = $pages->find("template=work,$workrange sort=-work_year");

$out = '<ul>';

foreach($works as $work) {
    $out .= "<li>{$work->title}- {$work->work_year}</li>"; 
}

$out .= '</ul>';

echo $out;

the selector works if i put the work_year<2000 directly in the code, it just doesn't work with hanna code.

it also works if I use an = sign not a > or <.... so i get results if i put in range==2000 to the tag, which makes the $range var be "=2000"

Share this post


Link to post
Share on other sites

so i guess i should assume that hanna code can't handle PHP comparison operators?

Share this post


Link to post
Share on other sites

so i guess i should assume that hanna code can't handle PHP comparison operators?

I guess it is safer to assume that Ryan has been quite busy lately ;):D

  • Like 1

Share this post


Link to post
Share on other sites

Sorry Kongondo, I guess it is safer to assume that Ryan has been quite busy as long as I know ProcessWire. :)

  • Like 1

Share this post


Link to post
Share on other sites

right thanks as always kongondo...  it's not a huge rush, i was just wondering if anyone else had done hanna codes with comparison operators, and if there were some examples i could look at to determine if I'm doing something wrong... i also think it will be good to eventually have a repository of hanna code examples; 

hanna codes are going to be really essential to this one site i'm working on, in order to let the editors place tags for redundant info, such as telephone # etc...

  • Like 1

Share this post


Link to post
Share on other sites
i was just wondering if anyone else had done hanna codes with comparison operators, 

I'm not sure I understand the question? The only thing I can think of you might be talking about is using comparison operators where you pass attributes to the Hanna code? The thing is, attributes are no different from HTML attributes (key=value)... they are assignments, not comparisons. So I'm confused about the question. 

Share this post


Link to post
Share on other sites

i just meant that i can't get this hanna code to work with less than or greater than symbols, like this:

[[works range=<2000]]

i get no results for the selector; this does work if i put the selector directly in the code, as per original post on this;

thanks!

Share this post


Link to post
Share on other sites

@Macrura: first of all, if you've enabled HTML Entity Encoder, make sure it comes in after, not before, Hanna Code textformatter. The code snippet you posted earlier works just fine for me, so I'm guessing something else is wrong.. most likely another textformatter messing with markup before it gets sent to Hanna Code.

If that doesn't solve your problem, try debugging your snippet, ie. what's the actual attribute value in there.

  • Like 2

Share this post


Link to post
Share on other sites

@teppo - thanks, i finally got it to work, i had to decode the > and < signs, that's what i was wondering about with hanna code and why i originally was asking about using comparison operators like > and <, since in the editor they get encoded and that's why the selectors were not working...

i just had to add this line and it works now:

if($range) $range = html_entity_decode($range);
  • Like 1

Share this post


Link to post
Share on other sites

I think I have discovered a bug with images.

When using the save+test feature, i get errors with image field.

THe image field is a single image field and I write:

$page->image->size(0,50)->url

TemplateFile: Method Pageimages::size does not exist or is not callable in this context

 
So no matter what image field max files is set to it's always threated as array. But on front-end the code works, just not in the preview/test.
 
I have to write 
 
$page->image->first()->size(0,50)->url
 
to make it work in the admin preview, but then the code doesn't work anymore on front-end.
 
 
Ace editor:
 
I already got this with the ace editor fieldtype from adam, the code has tabs added at the end of the text. Sometimes it grows and grows after saving the code...

Share this post


Link to post
Share on other sites
When using the save+test feature, i get errors with image field.

Soma, it sounds like output formatting is disabled in test mode. Can you try the attached to see if that fixes it?

TextformatterHannaCode.module

I already got this with the ace editor fieldtype from adam, the code has tabs added at the end of the text. Sometimes it grows and grows after saving the code...

Do you know if this is an issue with AceEditor, or something about the way I've implemented it? I only ask since you mentioned Adam's inputfield had the same issue. 

Share this post


Link to post
Share on other sites

div style="color:rgb(0,0,0);font-family:Times;font-size:medium;">Strange inability to migrate Hanna between two hosts

 
I have a local dev site that I copied to a remote dev site. All good (copy of files, export and import of DB).
 
Then on the remote dev site I added Hanna module, all good.
 
Now I have just re-sync'd the files back from the remote site to local (and sure enough the Module files for Hanna came down) and exported the remote db and imported it locally. All good, PW works AOK. Except however, the local system seems to only partially know it is meant to have Hanna.
 
If I look under Admin > Modules it's not listed, but there is a menu item for Setup > Hanna and I can visit it and PW admin says "This page has no Process assigned".
 
To date with all sites I have always used Navicat.app to simply Backup/Import in whichever direction I needed a db to be copied and all good. I will try actually deleting the local database, making a new empty one and then importing to that (in case it's something weird there) and report back in this thread. Did that and it made no difference.
 
Has anyone else had this problem?
 
Update 2013-10-01-0822 EST: I took a snapshot of the site and db (in case) and then went ahead and used Modules Manager to install Hanna (even tho it was already sorta installed). The 'install' occurred without a hitch, as if Hanna was not there, and the codes that had been plain text on the site immediately changed to their correct output.
 
Still puzzled and slightly concerned by this, hope reporting it is of some help if at some point it's debugged/explained. Update: I think based on what I suspect and Ryan's comment (below) it must have been a bad FTP, even tho I tried hard to rule that out (below x 2). Happy bunny ^_^
Edited by alanfluff

Share this post


Link to post
Share on other sites

It doesn't sound like a DB migration issue, it really sounds like a file migration issue. My best guess is either: 1) File permissions on your Hanna code modules rendered it unreadable to your web server; or 2) that you had Hanna code installed as a symlink on your source server, and the symlink didn't migrate or didn't match up on the target server. That would explain why you'd have a Hanna Code Setup menu item and DB entries, but no ability to run it. Installing through Modules manager would have fixed it since it knows to install the files into the right place with the right permissions, etc. 

  • Like 1

Share this post


Link to post
Share on other sites

Thanks very much for that analysis Ryan. It's good to read you think it's 'files' not 'database' and reading your comment I think that too.

I used Transmit.app and hopefully but perhaps not coincidentally it had crashed occasionally. On this occasion I was very careful to check it really thought the two sites were fully in sync but I am not confident that that test necessarily checks permissions etc and so perhaps it was an initial bad sync from my FTP that then got overlooked on subsequent check-sync runs.

Long story short, confidence still at 100% in PW and robustness (the most polished product of it's type I've used) and I'm off to look at alternatives to Transmit (tho there is much I like about it). Cheers!

  • Like 1

Share this post


Link to post
Share on other sites

I used to use Transmit and honestly never had the syncing working quite right with it. Though this was years ago, and Transmit is pretty much the most popular FTP app in OS X. I would be surprised if it were still buggy in that respect. I personally use Yummy FTP now, but I generally try to avoid using any FTP for transferring files unless it's the only option. I have a strong preference for rsync. 

  • Like 1

Share this post


Link to post
Share on other sites

On a completely other topic I was looking at rsync for webserver backup and as I was new to it the initial intro read was exciting as it looked like such a robust technology.

So I'm very interested to see you use rsync over FTP SFTP etc and I've seen only good comments so far re arRsync (rsync for command line weaklings).

Off to go have a play, thanks for the tip Ryan!

  • Like 1

Share this post


Link to post
Share on other sites

I really love rsnapshot: http://www.rsnapshot.org/

It is still command line and uses rsync, but handles all the incremental backup setup for you. Just setup and call from cron!

  • Like 3

Share this post


Link to post
Share on other sites

Strangely, i too have developed a great fondness for rsync as "it just bloody works !!" :rolleyes:

Have downloaded that app you linked to @alanfluff and will have a play. Perhaps its a good baby step towards learning how to use all those rsync options in the man pages? Shall see...

Speaking of which, I found this to be a really great and accessible link / reference to all the unix commands on a Mac: http://ss64.com/osx/

  • Like 1

Share this post


Link to post
Share on other sites

Thanks adrian and Zahari—checking out rsync and OSX ref bookmarked! ^_^

Share this post


Link to post
Share on other sites

having trouble with this, for some reason the hanna code is not working with atttributes like this [[accordion title=Some Title]]

this one has an attribute called 'link'.

all it outputs is "Some

but i don't get why my variable is not being fully passed to HC, i'm following the instructions from the ReadMe

<?php 
echo "<div class='trigger'>
	  <a href='#'>";
echo $link;
echo "</a>
      </div>
	  <div class='hide'>
	  ";
!HannaCode:accordion:eyJuYW1lIjoiYWNjb3JkaW9uIiwidHlwZSI6IjIiLCJjb2RlIjoiXC8qaGNfYXR0clxubGluaz1cIlNvbWUgVGV4dFwiXG5oY19hdHRyKlwvXG48P3BocCBcclxuZWNobyBcIjxkaXYgY2xhc3M9J3RyaWdnZXInPlxyXG5cdCAgPGEgaHJlZj0nIyc+XCI7XHJcbmVjaG8gJGxpbms7XHJcbmVjaG8gXCI8XC9hPlxyXG4gICAgICA8XC9kaXY+XHJcblx0ICA8ZGl2IGNsYXNzPSdoaWRlJz5cclxuXHQgIFwiOyJ9/!HannaCode

Share this post


Link to post
Share on other sites

@Macrura: are you using Hanna Code in a CKEditor field?

I recently debugged similar issue and eventually found out that it was caused by CKEditor encoding " to " (default behavior) before Hanna Code had a chance to grab it. Similar issues could be caused by other editors, textformatters placed before Hanna Code etc.

Share this post


Link to post
Share on other sites

yes - i'm using CK editor (and your hanna code helper...thanks for that!!!).;

so what would be the fix for this, is there a way to prevent CK editor from encoding automatically? 

this issue also relates to my posts a few up about php comparison operators like < and >; the reason those hanna codes were not working was from the same editor problem;

being that this is really a major issue for Hanna Code, i think this should be addressed, or at least some instructions or disclaimer in the readme file, as i have spent several hours trying to figure out a fix/workaround for this..

so i added this to the config.js:

config.entities = false;

not sure if this will have any impact on other areas, but it at least fixed this issue.

Share this post


Link to post
Share on other sites

Create an account or sign in to comment

You need to be a member in order to leave a comment

Create an account

Sign up for a new account in our community. It's easy!

Register a new account

Sign in

Already have an account? Sign in here.

Sign In Now

  • Recently Browsing   0 members

    No registered users viewing this page.

  • Similar Content

    • By tcnet
      PageViewStatistic for ProcessWire is a module to log page visits of the CMS. The records including some basic information like IP-address, browser, operating system, requested page and originate page. Please note that this module doesn't claim to be the best or most accurate.
      Advantages
      One of the biggest advantage is that this module doesn't require any external service like Google Analytics or similar. You don't have to modify your templates either. There is also no Javascript or image required.
      Disadvantages
      There is only one disadvantage. This module doesn't record visits if the browser loads the page from its browser cache. To prevent the browser from loading the page from its cache, add the following meta tags to the header of your page:
      <meta http-equiv="Cache-Control" content="no-cache, no-store, must-revalidate" /> <meta http-equiv="Pragma" content="no-cache" /> <meta http-equiv="Expires" content="0" /> How to use
      The records can be accessed via the Setup-menu of the CMS backend. The first dropdown control changes the view mode.

      Detailed records
      View mode "Detailed records" shows all visits of the selected day individually with IP-address, browser, operating system, requested page and originate page. Click the update button to see new added records.

      Cached visitor records
      View modes other than "Detailed records" are cached visitor counts which will be collected on a daily basis from the detailed records. This procedure ensures a faster display even with a large number of data records. Another advantage is that the detailed records can be deleted while the cache remains. The cache can be updated manually or automatically in a specified time period. Multiple visits from the same IP address on the same day are counted as a single visitor.

      Upgrade from older versions
      Cached visitor counts is new in version 1.0.8. If you just upgraded from an older version you might expire a delay or even an error 500 if you display cached visitor counts. The reason for this is that the cache has to be created from the records. This can take longer if your database contains many records. Sometimes it might hit the maximally execution time. Don't worry about that and keep reloading the page until the cache is completely created.
      Special Feature
      PageViewStatistic for ProcessWire can record the time a visitor viewed the page. This feature is deactivated by default. To activate open the module configuration page and activate "Record view time". If activated you will find a new column "S." in the records which means the time of view in seconds. With every page request, a Javascript code is inserted directly after the <body> tag. Every time the visitor switches to another tab or closes the tab, this script reports the number of seconds the tab was visible. The initial page request is recorded only as a hyphen (-).

      Settings
      You can access the module settings by clicking the Configuration button at the bottom of the records page. The settings page is also available in the menu: Modules->Configure->ProcessPageViewStat.
      IP2Location
      This module uses the IP2Location database from: http://www.ip2location.com. This database is required to obtain the country from the IP address. IP2Location updates this database at the begin of every month. The settings of ProcessPageViewStat offers the ability to automatically download the database monthly. Please note, that automatically download will not work if your webspace doesn't allow allow_url_fopen.
      Dragscroll
      This module uses DragScroll. A JavaScript available from: http://github.com/asvd/dragscroll. Dragscroll adds the ability in view mode "Day" to drag the records horizontally with the mouse pointer.
      parseUserAgentStringClass
      This module uses the PHP class parseUserAgentStringClass available from: http://www.toms-world.org/blog/parseuseragentstring/. This class is required to filter out the browser type and operating system from the server request.
    • By Mike Rockett
      TextformatterTypographer
      A ProcessWire wrapper for the awesome PHP Typography class, originally authored by KINGdesk LLC and enhanced by Peter Putzer in wp-Typography. Like Smartypants, it supercharges text fields with enhanced typography and typesetting, such as smart quotations, hyphenation in 59 languages, ellipses, copyright-, trade-, and service-marks, math symbols, and more.
      It's based on the PHP-Typography library found over at wp-Typography, which is more frequently updated and feature rich that its original by KINGdesk LLC.
      The module itself is fully configurable. I haven't done extensive testing, but there is nothing complex about this, and so I only envisage a typographical bug here and there, if any.
    • By robert
      I often had the need for an overview of all used fields and their contents for a specific page/template while developing new websites without switching to the backend, so I made a small module which lists all the needed information in a readable manner (at least for me):
      Debug Page Fields
      https://github.com/robertweiss/ProcessDebugPageFields
      It adds two new properties to all pages:
      $page->debugFieldValues – returns an object with all (sub-)fields, their labels, fieldtypes and values $page->debugFieldTypes – returns an object with all fieldtypes and their corresponding fields // List all values of a pages $page->debugFieldValues // List a specific field $page->debugFieldValues->fieldname // List all used fieldtypes of a page $page->debugFieldTypes I recommend using it in combination with Tracy Debugger, Ray, Xdebug etc. as it returns an object and is only meant for developing/debugging uses. 
      For now, the fieldtype support includes mostly fieldtypes I use in my projects, but can easily be extended by adding a new FieldtypeFIELDNAME method to the module. I use it with five different client installations (all PW 3.0.*), but of course there might be some (or more) field configurations which are not covered correctly yet.
      Supported fieldtypes
      Button Checkbox Color Combo Datetime Email FieldsetPage * File FontIconPicker Functional Image ImageReference MapMarker Multiplier Mystique Options Page PageIDs PageTitle Radio Repeater * RepeaterMatrix * RockAwesome SeoMaestro Table Text Textarea Textareas Toggle URL * The fields with complete subfield-support also list their corresponding subfields.
      Installation
      Download the zip file at Github or clone the repo into your site/modules directory. If you downloaded the zip file, extract it in your sites/modules directory. In your admin, go to Modules > Refresh, then Modules > New, then click on the Install button for this module. As this is my first ›public‹ module, I hope I did not miss any important things to mention here.
    • By horst
      Wire Mail SMTP

      An extension to the (new) WireMail base class that uses SMTP-transport

      This module integrates EmailMessage, SMTP and SASL php-libraries from Manuel Lemos into ProcessWire. I use this continously evolved libraries for about 10 years now and there was never a reason or occasion not to do so. I use it nearly every day in my office for automated composing and sending personalized messages with attachments, requests for Disposition Notifications, etc. Also I have used it for sending personalized Bulkmails many times.

      The WireMailSmtp module extends the new email-related WireMail base class introduced in ProcessWire 2.4.1 (while this writing, the dev-branch only).
       
      Here are Ryans announcement.



      Current Version 0.6.0
      Changelog: https://github.com/horst-n/WireMailSmtp/blob/master/CHANGELOG.md
      get it from the Modules Directory Install and Configure

      Download the module into your site/modules/ directory and install it.

      In the config page you fill in settings for the SMTP server and optionaly the (default) sender, like email address, name and signature.
      You can test the smtp settings directly there. If it says "SUCCESS! SMTP settings appear to work correctly." you are ready to start using it in templates, modules or bootstrap scripts.


      Usage Examples
      The simplest way to use it:
      $numSent = wireMail($to, $from, $subject, $textBody); $numSent = wireMail($to, '', $subject, $textBody); // or with a default sender emailaddress on config page This will send a plain text message to each recipient.
       
      You may also use the object oriented style:
      $mail = wireMail(); // calling an empty wireMail() returns a wireMail object $mail->to($toEmail, $toName); $mail->from = $yourEmailaddress; // if you don't have set a default sender in config // or if you want to override that $mail->subject($subject); $mail->body($textBody); $numSent = $mail->send(); Or chained, like everywhere in ProcessWire:
      $mail = wireMail(); $numSent = $mail->to($toEmail)->subject($subject)->body($textBody)->send(); Additionaly to the basics there are more options available with WireMailSmtp. The main difference compared to the WireMail BaseClass is the sendSingle option. With it you can set only one To-Recipient but additional CC-Recipients.
      $mail = wireMail(); $mail->sendSingle(true)->to($toEmail, $toName)->cc(array('person1@example.com', 'person2@example.com', 'person3@example.com')); $numSent = $mail->subject($subject)->body($textBody)->send(); The same as function call with options array:
      $options = array( 'sendSingle' => true, 'cc' => array('person1@example.com', 'person2@example.com', 'person3@example.com') ); $numSent = wireMail($to, '', $subject, $textBody, $options); There are methods to your disposal to check if you have the right WireMail-Class and if the SMTP-settings are working:
      $mail = wireMail(); if($mail->className != 'WireMailSmtp') { // Uups, wrong WireMail-Class: do something to inform the user and quit echo "<p>Couldn't get the right WireMail-Module (WireMailSmtp). found: {$mail->className}</p>"; return; } if(!$mail->testConnection()) { // Connection not working: echo "<p>Couldn't connect to the SMTP server. Please check the {$mail->className} modules config settings!</p>"; return; }  
      A MORE ADVANCED DEBUG METHOD!
      You can add some debug code into a template file and call a page with it:
      $to = array('me@example.com'); $subject = 'Wiremail-SMTP Test ' . date('H:i:s') . ' äöü ÄÖÜ ß'; $mail = wireMail(); if($mail->className != 'WireMailSmtp') { echo "<p>Couldn't get the right WireMail-Module (WireMailSmtp). found: {$mail->className}</p>"; } else { $mail->from = '--INSERT YOUR SENDER ADDRESS HERE --'; // <--- !!!! $mail->to($to); $mail->subject($subject); $mail->sendSingle(true); $mail->body("Titel\n\ntext text TEXT text text\n"); $mail->bodyHTML("<h1>Titel</h1><p>text text <strong>TEXT</strong> text text</p>"); $dump = $mail->debugSend(1); } So, in short, instead of using $mail->send(), use $mail->debugSend(1) to get output on a frontend testpage.
      The output is PRE formatted and contains the areas: SETTINGS, RESULT, ERRORS and a complete debuglog of the server connection, like this one:
       
      Following are a ...


      List of all options and features


      testConnection () - returns true on success, false on failures


      sendSingle ( true | false ) - default is false

      sendBulk ( true | false ) - default is false, Set this to true if you have lots of recipients (50+)


      to ($recipients) - one emailaddress or array with multiple emailaddresses

      cc ($recipients) - only available with mode sendSingle, one emailaddress or array with multiple emailaddresses

      bcc ($recipients) - one emailaddress or array with multiple emailaddresses

       
      from = 'person@example.com' - emailaddress, can be set in module config (called Sender Emailaddress) but it can be overwritten here

      fromName = 'Name Surname' - optional, can be set in module config (called Sender Name) but it can be overwritten here


      priority (3) - 1 = Highest | 2 = High | 3 = Normal | 4 = Low | 5 = Lowest

      dispositionNotification () or notification () - request a Disposition Notification


      subject ($subject) - subject of the message

      body ($textBody) - use this one alone to create and send plainText emailmessages

      bodyHTML ($htmlBody) - use this to create a Multipart Alternative Emailmessage (containing a HTML-Part and a Plaintext-Part as fallback)

      addSignature ( true | false ) - the default-behave is selectable in config screen, this can be overridden here
      (only available if a signature is defined in the config screen)

      attachment ($filename, $alternativeBasename = "") - add attachment file, optionally alternative basename


      send () - send the message(s) and return number of successful sent messages


      debugSend(1) - returns and / or outputs a (pre formatted) dump that contains the areas: SETTINGS, RESULT, ERRORS and a complete debuglog of the server connection. (See above the example code under ADVANCED DEBUG METHOD for further instructions!)


      getResult () - returns a dump (array) with all recipients (to, cc, bcc) and settings you have selected with the message, the message subject and body, and lists of successfull addresses and failed addresses,


      logActivity ($logmessage) - you may log success if you want

      logError ($logmessage) - you may log warnings, too. - Errors are logged automaticaly
       
       
      useSentLog (true | false) - intended for usage with e.g. third party newsletter modules - tells the send() method to make usage of the sentLog-methods - the following three sentLog methods are hookable, e.g. if you don't want log into files you may provide your own storage, or add additional functionality here

      sentLogReset ()  - starts a new LogSession - Best usage would be interactively once when setting up a new Newsletter

      sentLogGet ()  - is called automaticly within the send() method - returns an array containing all previously used emailaddresses

      sentLogAdd ($emailaddress)  - is called automaticly within the send() method
      Changelog: https://github.com/horst-n/WireMailSmtp/blob/master/CHANGELOG.md
       
       
    • By Cybermano
      Food Allergens Module
      A simple List of Food Allergens
      My needs were to provide a simple list of food allergens for our clients with restaurant related activity.
      The idea was to simply output the list (to speed up the data entry) without leaving the food menu editing, eg. opening another page in new tab or window.
      This isn't a perfect solution, but it works fine for my needs and I decided to share the base idea.
      This could also be easily used to show little notes or short "vademecum", not only for the list of food allergens.
      ---
      Main features
      The basis
      All moves from a short editing of the module in this tutorial: How to create custom admin pages by @bernhard
      First of all it creates an empty admin page, with a dedicated permission to let safe-user to see it (this permission has to be created as a new ones, manually or by the module).
      Once the page is created, I have hooked its behaviour into the ready.php, to show the content (basically a list).
      A step further
      With the tips of  @bernhard, @Soma (and many others), see here , the magic happens. 
      The new page will be shown as a panel, so editors will not abandon their data entry to have a quick view to the list.
      A little further
      Why scroll to the top of the page to click a link?
      The next step was to create a sticky button only in the food menu pages.
      Again with a @bernhard tip I moved into the customization of this simple module and the related hook.
      ---
      How to use this module
      After installed, it creates the page /admin/page/allergens/ and the module is to be setted up. The first field is a CKEditor with multi-language. This is the place where to write the informations that will be shown into the page. The next field is a simply text-area where to place a bit of JS that will be appended to the markup of the text (omit the 'script' tags). I also putted a checkbox with a silly statement: this to think at least twice on the safety of the written JS. Now comes the first way to display the link to the page
      Field Note with Link. Enable and save it. The module will display a new row with 4 selects (1 standard and 3 ASM):
      View mode (to show the page as Panel or as Modal PopUp); Templates to select: select one or more and save before proceed, so the  asm-select of the pages will be populated showing all the pages of the selected templates. Pages to select: also here select at least one and save before proceed to populate the asm-select for fields only with the ones that belong to the selected pages. Select the fields where to place the note and save again. That's all: now you will find into the notes of the selected fields the link "See the List of Allergens".
      At the same way, the option for the sticky button, but with a plus
      The field select is obviously unnecessary, but you could play with the last row: the inline styles to fix your sticky button where you like. Here you could set the sticky position of the <div> and the absolute ones of the <a>.

      Video Explanation
      In these screencasts you could see a custom JS that show a "copy" button near a "hanna-code" call.
      This because I've set a specific one for each allergen to show up a tooltip in the front end.

      Registrazione #33.mp4  

      Registrazione #34.mp4 ---
      Last but not the least
      Actually it works fine for my needs, even if it's much improvable: I'm working on the permissions creation, the uninstall section, a separate configs and defaults and how to include the hook into the module leaving free the ready.php. According to a simpler uninstall. Also I would make the link text as a dynamic text field, so it will be more flexible.
      I always learn a lot here, so I would share my code for whom it could be interested.
      I removed the hanna code references, but I provide you the html list of the allergens, English and Italian too, so you can paste them into the "source" of the CKEditor field to have a ready to use module.
      Obviously you are free to modify the code as per your needs.
      Please, keep in mind that I'm not a pro coder and I beg your pardon for my verbosity (speaking and coding). 😉
      I hope be helpful or for inspiration.
      Bye
      ready.phpList-ITA.htmlList-ENG.htmlAllergens.module
      README.md
×
×
  • Create New...