Jump to content
Robin S

HannaCodeDialog

Recommended Posts

33 minutes ago, tpr said:

how about adding items that wouldn't require Hanna code module? What I have in mind is having eg a

$config->hannaCodeDialogItems = array( item1 => function () { ... }, ... )

code somewhere in template files so one could easily insert custom items to ckeditor?

Not sure I understand fully, but wouldn't that be reinventing the wheel? Hanna Code already does a great job of allowing the result of any custom code/function to be inserted into a textarea.

35 minutes ago, tpr said:

Perhaps $config could be replaced with $page.

Do you mean so you could have certain tags that are available only on certain pages? Because that is what the getDropdownTags() hook allows for:

 

Share this post


Link to post
Share on other sites

The main motivation is to make the module work without the Hanna code module.

config/page: its just a different approach to have a value available for the module. Perhaps $config is more appropriate here.

Share this post


Link to post
Share on other sites
9 hours ago, Robin S said:

Thanks for the report. Are you running PHP 7.1? I think that's the version that started enforcing stricter numeric values and throwing errors like this.

I tested in PHP7.1 and I can't reproduce this issue. Also, I can't see how this error could be connected to HannaCodeDialog. From what I've read the "non well formed numeric value" error occurs when some arithmetic or other operation that expects an integer receives a string instead. And line 118 of Database.php is:


$timerTotalSinceStart = Debug::timer() - $timerFirstStartTime;

So probably Debug::timer() or $timerFirstStartTime is not an integer, but this is core code that relates to the debug mode tools and HannaCodeDialog has nothing to do with that.

Do you see the error as soon as you install HannaCodeDialog? Do you see it if you have no Hanna codes defined when the module is installed (I'm wondering if the problem is with one of your Hanna codes rather than the module itself)? If you uninstall HannaCodeDialog does the error go away?

 

I will support this in the next version. The intention was to avoid needlessly attaching the plugins to every instance of CKEditor if the textformatter wasn't applied to that field, but I guess to support $hanna->render() there's no way to know if a CKEditor field needs the plugins or not.

 

I'm having trouble understanding exactly what's going wrong for you here. Make sure you meet the prerequisites and have completed the installation process:

  • TextformatterHannaCode must be installed.
  • TextformatterHannaCode must be applied as a textformatter to your CKEditor field.
  • You must have at least one Hanna code created.
  • Install HannaCodeDialog module.
  • Edit the settings for your CKEditor field and in "Input > CKEditor Settings > CKEditor Toolbar" add "HannaDropdown" (to be precise, with a comma space separating it from the other items there)

 

Yes I'm running on PHP 7.1.1 and all of the steps are done.

I switched to PHP 7.0.15 and the error is now gone. PHP 7.0.15 is okay for me - so I can ingore the error for now

 

 

Share this post


Link to post
Share on other sites
15 hours ago, Robin S said:

 

  • TextformatterHannaCode must be installed.
  • TextformatterHannaCode must be applied as a textformatter to your CKEditor field.
  • You must have at least one Hanna code created.
  • Install HannaCodeDialog module.
  • Edit the settings for your CKEditor field and in "Input > CKEditor Settings > CKEditor Toolbar" add "HannaDropdown" (to be precise, with a comma space separating it from the other items there)

Followed this, -> Works

Thanks a lot

Share this post


Link to post
Share on other sites

Is HannaDropdown supposed to work on ProFields Textareas too?

Because I can't get it to show on multiple textareas with CKE, but perfectly on a single CKE textarea. 

PW 3.0.42 and ProFields Textareas 0.0.6

Share this post


Link to post
Share on other sites
10 hours ago, Klenkes said:

Is HannaDropdown supposed to work on ProFields Textareas too?

Well it wasn't something I tested for specifically, but it was pretty easy to add support for ProFields Textareas so I have done that in v0.0.6.

  • Like 3

Share this post


Link to post
Share on other sites

Haha, that was quick :o

Works like a charm! Thanks!

Share this post


Link to post
Share on other sites

Hi Robin,

Great module. Is the module dialog supposed to allow you to edit existing Hanna Codes? When I double click an existing code, it opens in the dialog but none of the inputs are filled out. If I save, then all of the content disappears.

Another issue I ran into after upgrading to the latest build: The cancel button on the dialog no longer works. The JS error I'm getting is: "hannadialog.js?t=2015030801.157:32 Uncaught TypeError: Cannot read property 'setAttribute' of null"

  • Like 1

Share this post


Link to post
Share on other sites
8 hours ago, thetuningspoon said:

Another issue I ran into after upgrading to the latest build: The cancel button on the dialog no longer works. The JS error I'm getting is: "hannadialog.js?t=2015030801.157:32 Uncaught TypeError: Cannot read property 'setAttribute' of null"

That's a bug, sorry. I missed something in the JS in a recent update. Should be fixed now in v0.0.7.

 

8 hours ago, thetuningspoon said:

Is the module dialog supposed to allow you to edit existing Hanna Codes? When I double click an existing code, it opens in the dialog but none of the inputs are filled out. If I save, then all of the content disappears.

Yes, the module should work for existing Hanna codes. I can't reproduce that issue here. If the v0.0.7 update doesn't fix things for you could you give me some more info: any JS console errors, the PW version, TextformatterHannaCode version, and an export of a Hanna code that you see the issue with? Edit: also please let me know how the Hanna tag looks in your CKEditor field - i.e. are the attribute values inside quotes, single or double?

  • Like 1

Share this post


Link to post
Share on other sites

The close button is working now, but opening an existing code now shows a completely blank iframe in the popup.

58efb8190a422_ScreenShot2017-04-13at1_38_15PM.thumb.png.7151845c04b5384bb93fe134a26754c9.png58efb812a1315_ScreenShot2017-04-13at1_38_06PM.thumb.png.2f16545ffb4a792d2bf7a448b5c78e6a.png

PW version is 3.0.40. Hanna code is 0.2.0

Edit: No console errors, either.

  • Like 1

Share this post


Link to post
Share on other sites

@thetuningspoon, thanks, I couldn't reproduce the issue exactly as you're seeing it but I think I have found the source of the problem. For some reason I didn't anticipate using long strings of text for attribute values. So I've added support for that in v0.0.8 and now if the length of a value is greater than 50 characters a textarea is used in the dialog instead of a text input. The breakpoint at which a textarea is used is configurable in the module settings.

Please let me know if this doesn't fix the issue for you.

  • Like 1

Share this post


Link to post
Share on other sites
2 minutes ago, thetuningspoon said:

Does this also mean that textareas are a configurable input type now?

I had thought it would be nicer if the module decided automatically based on the length of the attribute value you give it, but now that you mention this I can see that my idea won't work very well when inserting a new tag, where the length will be zero until it is populated. So in v0.0.9 I have removed that breakpoint idea and now you can manually specify the textarea inputfield type for an attribute, e.g.

myattribute__type=textarea

 

  • Like 1

Share this post


Link to post
Share on other sites

@Robin S Yeah, that makes sense. Just tested the previous build and found that it is still stripping out the long text inputs after re-saving them. Did you resolve this in your latest update?

Share this post


Link to post
Share on other sites
13 minutes ago, thetuningspoon said:

Just tested the previous build and found that it is still stripping out the long text inputs after re-saving them.

v0.1.0: this time hopefully... :)

  • Like 1

Share this post


Link to post
Share on other sites

@thetuningspoon, I just pushed another small change in v0.1.1 to remove any manual line breaks that a user might insert inside a textarea. Manual line breaks cannot be supported because they break the CKEditor tag widget.

  • Like 1

Share this post


Link to post
Share on other sites

After using this module for a while, I have a couple of suggestions for future modifications.

First, would it be possible to skip the dialogue window (or auto-close it) if the Hanna code being added does not have any attributes set?  It could still have the on-click behaviour after being added (with the "This tag has no editable attributes" message), to future-proof the tag should the user add attributes in the future. Obviously, one could just type the Hanna code, but it is more convenient for clients to pick it from a list.

Secondly, this isn't really a suggestion, but a custom modification I made to the code for my own purposes, which might be useful to others.

When using selectable option fields (selects, radios, etc), the current method to set the different options is simply:

attribute__options=Option A|Option B|Option C

// The option string format is the same for dyanamically generated options.

With this method, the option field input 'value' and 'text/label' are the same.

However, I found that this was not very user-friendly when the options are somewhat cryptic. Eg, from a returned file list:

  • file123-xyz.pdf
  • abc-1978.pdf
  • xyz-blah123.pdf
  • really-long-title-2017-05-apple-blueberry-banana.pdf

So, what I did was modify the foreach loop code in the file 'iframe_form.php' at line #63, to make it possible to have a separate input value and text.
 

/* Original code at line #63 in iframe_form.php */
foreach ($select_options as $select_option) {
    $f->addOption($select_option);
}

/* My own modification
 * - Searches the option value for '@@'
 * - Uses it to split the string into two variables: $optionValue and $optionText
 * - Then adds the option to the select field.
 */
foreach ($select_options as $select_option) {
    if (strpos($select_option, "@@") !== false) {
        list($optionValue, $optionText) = explode("@@", $select_option);
        $f->addOption($optionValue, $optionText);
    } else {
        $f->addOption($select_option);
    }
}


Now, when setting the options, you specify them (either directly or dynamically) by separating each option's value and text/label with '@@' (chosen because it's unlikely to be part of an option value or text):

attribute__options=file123-xyz.pdf@@Annual Accounts 2016|abc-1978.pdf@@Some Meaningiful Title|xyz-blah123.pdf@@Another Meaningful Title|
really-long-title-2017-05-apple-blueberry-banana.pdf@@The Price of Fruit May 2017

// Note: in reality the above options would be generated dynamically.

 

I would make a pull request (?) via GitHub for this, but I've never used it for such a thing and don't really know how.

 

Edited by LMD
Terrible typos caused by being in a hurry originally.
  • Like 2

Share this post


Link to post
Share on other sites
12 hours ago, LMD said:

First, would it be possible to skip the dialogue window (or auto-close it) if the Hanna code being added does not have any attributes set?

I agree this would be an improvement and will add it in the next release.

 

12 hours ago, LMD said:

Now, when setting the options, you specify them (either directly or dynamically) by separating each option's value and text/label with '@@'

I'm not opposed to adding this as such but I want to be sure that it's the best way forward. Besides making the module usage that bit more complicated, the issue to me is that the tag as it appears in the CKEditor window is readable text - a site editor can look at the tag and it makes some sense. If you display a different string of text in the dialog inputfield than what is inserted into the tag then I think this could be confusing for site editors.

You are saying you have some options where there is a human-friendly label and a not-so-friendly value that you actually need for use inside the tag's code. Wouldn't it be better to only ever show the human-friendly label in the tag and dialog, and then match the label to the needed value inside your Hanna code? So if you, the developer, know that "file123-xyz.pdf" is aka "Annual Accounts 2016" then in your Hanna tag code you have something like:

if($file == 'Annual Accounts 2016') $file = 'file123-xyz.pdf';

Of course you could use switch() for multiple cases, or look up filenames from the descriptions, or match the label to value in whatever way you would have done when assigning "value@@label" under your proposal. Does that make sense? Any other users have an opinion on this?

Share this post


Link to post
Share on other sites
18 hours ago, Robin S said:

I'm not opposed to adding this as such but I want to be sure that it's the best way forward. Besides making the module usage that bit more complicated, the issue to me is that the tag as it appears in the CKEditor window is readable text - a site editor can look at the tag and it makes some sense. If you display a different string of text in the dialog inputfield than what is inserted into the tag then I think this could be confusing for site editors.

Yea there's a trade-off here.  Personally, I think inserting the IDs is the best route since IDs do not change (while text does).  Unless there's a really fancy way to satisfy both needs through some sort of richer CKEditor widget?

Share this post


Link to post
Share on other sites
6 hours ago, Jonathan Lahijani said:

Personally, I think inserting the IDs is the best route since IDs do not change (while text does).

To my way of thinking, numeric IDs are the worst case in terms of being editor friendly. I see HannaCodeDialog as being a kind of progressive enhancement of Hanna Code, such that in the future you could uninstall HannaCodeDialog and still have tags that an editor can understand and use. But with numeric IDs you'll have tags along the lines of...

[[my_tag file="34784" options="4745|9748|8985"]]

And that seems contrary to the whole idea of Hanna Code, which is about giving editors easy to understand options while you the developer do the heavy lifting (be it matching editor-friendly names to IDs or whatever) behind the scenes in the tag code.

Having said that, I'd like the module to be flexible and let devs decide for themselves how they want to use it. So happy to announce...

 

HannaCodeDialog v0.1.2

  • Inserting a tag from the dropdown no longer opens the dialog if the tag has no editable options.
  • A new method prepareOptions() can be hooked in order to define or manipulate the options that can be selected for a tag attribute. See the module readme for more.

 

@LMD, you can hook this new method to set separate value and label as per your proposal:

$wire->addHookAfter('HannaCodeDialog::prepareOptions', function($event) {
    $options = $event->return;
    $new_options = array();
    foreach($options as $option) {
        if(strpos($option, '@@') !== false) {
            list($value, $label) = explode('@@', $option);
            $new_options[$value] = $label;
        } else {
            $new_options[$option] = $option;
        }
    }
    $event->return = $new_options;
});

 

  • Like 6

Share this post


Link to post
Share on other sites
5 hours ago, Robin S said:

HannaCodeDialog v0.1.2

  • Inserting a tag from the dropdown no longer opens the dialog if the tag has no editable options.
  • A new method prepareOptions() can be hooked in order to define or manipulate the options that can be selected for a tag attribute. See the module readme for more.

@Robin S Jonathan's concern regarding the stability of 'IDs' vs. 'text' was one of my concerns. After thinking about it, I was going to suggest if a hookable method was possible, so this makes me happy.  I'll try it out today and report back!

 

  • Like 1

Share this post


Link to post
Share on other sites
On 5/23/2017 at 2:50 AM, LMD said:

@Robin S Jonathan's concern regarding the stability of 'IDs' vs. 'text' was one of my concerns. After thinking about it, I was going to suggest if a hookable method was possible, so this makes me happy.  I'll try it out today and report back!

 

I tested out the new version and it works really well.  Thanks @Robin S.

  • Like 1

Share this post


Link to post
Share on other sites

i was having trouble getting this – i had these as attributes

underline__type=radios
underline__options=None|Top|Bottom|Both
underline__description=Please select your border options.

but not working, so i tried this:

underline
underline__type=radios
underline__options=None|Top|Bottom|Both
underline__description=Please select your border options.

and it works;

i don't think this is clear from the instructions – would be great if there were more working examples to copy/paste, in the cheatsheet

  • Like 1

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 Sten
      Hello
      Till now I hacked something with the twig template but it works no more with new PW versions so I look forward to create a module. I am working on a site in multiple languages : French, English, Italian, German, Spanish, Portuguese, Hebrew, Russian. The new posts are entered in any language with a field for language. Till now, I got twig files to get the translations with constants defined for each part of the pages.
      So I'd like to create a module to include theses files added according to the url /fr/en/...
      Have you some observations to do before I begin about the direction to take ?
      Thank you
    • By ukyo
      Mystique Module for ProcessWire CMS/CMF
      Github repo : https://github.com/trk/Mystique
      Mystique module allow you to create dynamic fields and store dynamic fields data on database by using a config file.
      Requirements
      ProcessWire 3.0 or newer PHP 7.0 or newer FieldtypeMystique InputfieldMystique Installation
      Install the module from the modules directory:
      Via Composer:
      composer require trk/mystique Via git clone:
      cd your-processwire-project-folder/ cd site/modules/ git clone https://github.com/trk/Mystique.git Module in live reaction with your Mystique config file
      This mean if you remove a field from your config file, field will be removed from edit screen. As you see on youtube video.
      Using Mystique with your module or use different configs path, autoload need to be true for modules
      Default configs path is site/templates/configs/, and your config file name need to start with Mystique. and need to end with .php extension.
      Adding custom path not supporting anymore !
      // Add your custom path inside your module class`init` function, didn't tested outside public function init() { $path = __DIR__ . DIRECTORY_SEPARATOR . 'configs' . DIRECTORY_SEPARATOR; Mystique::add($path); } Mystique module will search site/modules/**/configs/Mystique.*.php and site/templates/Mystique.*.php paths for Mystique config files.
      All config files need to return a PHP ARRAY like examples.
      Usage almost same with ProcessWire Inputfield Api, only difference is set and showIf usage like on example.
      <?php namespace ProcessWire; /** * Resource : testing-mystique */ return [ 'title' => __('Testing Mystique'), 'fields' => [ 'text_field' => [ 'label' => __('You can use short named types'), 'description' => __('In file showIf working like example'), 'notes' => __('Also you can use $input->set() method'), 'type' => 'text', 'showIf' => [ 'another_text' => "=''" ], 'set' => [ 'showCount' => InputfieldText::showCountChars, 'maxlength' => 255 ], 'attr' => [ 'attr-foo' => 'bar', 'attr-bar' => 'foo' ] ], 'another_text' => [ 'label' => __('Another text field (default type is text)') ] ] ]; Example:
      site/templates/configs/Mystique.seo-fields.php <?php namespace ProcessWire; /** * Resource : seo-fields */ return [ 'title' => __('Seo fields'), 'fields' => [ 'window_title' => [ 'label' => __('Window title'), 'type' => Mystique::TEXT, // or InputfieldText 'useLanguages' => true, 'attr' => [ 'placeholder' => __('Enter a window title') ] ], 'navigation_title' => [ 'label' => __('Navigation title'), 'type' => Mystique::TEXT, // or InputfieldText 'useLanguages' => true, 'showIf' => [ 'window_title' => "!=''" ], 'attr' => [ 'placeholder' => __('Enter a navigation title') ] ], 'description' => [ 'label' => __('Description for search engines'), 'type' => Mystique::TEXTAREA, 'useLanguages' => true ], 'page_tpye' => [ 'label' => __('Type'), 'type' => Mystique::SELECT, 'options' => [ 'basic' => __('Basic page'), 'gallery' => __('Gallery'), 'blog' => __('Blog') ] ], 'show_on_nav' => [ 'label' => __('Display this page on navigation'), 'type' => Mystique::CHECKBOX ] ] ]; Searching data on Mystique field is limited. Because, Mystique saving data to database in json format. When you make search for Mystique field, operator not important. Operator will be changed with %= operator.
      Search example
      $navigationPages = pages()->find('my_mystique_field.show_on_nav=1'); $navigationPages = pages()->find('my_mystique_field.page_tpye=gallery');
    • By Robin S
      This is a module I made as an experiment a while ago and never got around to releasing publicly. At the time it was prompted by discussions around using Repeater fields for "page builder" purposes, where the depth feature could possibly be used for elements that would be nested inside other elements. I thought it would be useful to enforce some depth rules and translate the depth data into a multi-dimensional array structure.
      I'm not using this module anywhere myself but maybe it's useful to somebody.
      Repeater Depth Helper
      This module does two things relating to Repeater fields that have the "Item depth" option enabled:
      It enforces some depth rules for Repeater fields on save. Those rules are:
      The first item must have a depth of zero. Each item depth must not be more than one greater than previous item depth. It provides a RepeaterPageArray::getDepthStructure helper method that returns a nested depth structure for a Repeater field value.
      Helper method
      The module adds a RepeaterPageArray::getDepthStructure method that returns a multi-dimensional array where the key is the page ID and the value is an array of nested "child" items, or null if there are no nested children.
      Example

      The module doesn't make any assumptions about how you might want to use the depth structure array, but here is a way you might use it to output a nested unordered list.
      // Output a nested unordered list from a depth structure array function outputNestedList($depth_structure, $repeater_items) { $out = "<ul>"; foreach($depth_structure as $page_id => $nested_children) { $out .= "<li>" . $repeater_items->get("id=$page_id")->title; // Go recursive if there are nested children if(is_array($nested_children)) $out .= outputNestedList($nested_children, $repeater_items); $out .= "</li>"; } $out .= "</ul>"; return $out; } $repeater_items = $page->my_repeater; $depth_structure = $repeater_items->getDepthStructure(); echo outputNestedList($depth_structure, $repeater_items);
       
      https://github.com/Toutouwai/RepeaterDepthHelper
      https://modules.processwire.com/modules/repeater-depth-helper/
    • By MoritzLost
      Cacheable Placeholders
      This module allows you to have pieces of dynamic content inside cached output. This aims to solve the common problem of having a mostly cacheable site, but with pieces of dynamic output here and there.  Consider this simple example, where you want to output a custom greeting to the current user:
      <h1>Good morning, <?= ucfirst($user->name) ?></h1> This snippet means you can't use the template cache (at least for logged-in users), because each user has a different name. Even if 99% of your output is static, you can only cache the pieces that you know won't include this personal greeting. A more common example would be CSRF tokens for HTML forms - those need to be unique by definition, so you can't cache the form wholesale.
      This module solves this problem by introducing cacheable placeholders - small placeholder tokens that get replaced during every request. The replacement is done inside a Page::render hook so it runs during every request, even if the response is served from the template cache. So you can use something like this:
      <h1>Good morning, {{{greeting}}}</h1> Replacement tokens are defined with a callback function that produces the appropriate output and added to the module through a simple hook:
      // site/ready.php wire()->addHookAfter('CachePlaceholders::getTokens', function (HookEvent $e) { $tokens = $e->return; $tokens['greeting'] = [ 'callback' => function (array $tokenData) { return ucfirst(wire('user')->name); } ]; $e->return = $tokens; }); Tokens can also include parameters that are parsed and passed to the callback function. There are more fully annotated examples and step-by-step instructions in the README on Github!
      Features
      A simple and fast token parser that calls the appropriate callback and runs automatically. Tokens may include multiple named or positional parameters, as well as multi-value parameters. A manual mode that allows you to replace tokens in custom pieces of cached content (useful if you're using the $cache API). Some built-in tokens for common use-cases: CSRF-Tokens, replacing values from superglobals and producing random hexadecimal strings. The token format is completely customizable, all delimiters can be changed to avoid collisions with existing tag parsers or template languages. Links
      Github Repository & documentation Module directory If you are interested in learning more, the README is very extensive, with more usage examples, code samples and usage instructions!
    • By MoritzLost
      This module allows you to integrate hCaptcha bot / spam protection into ProcessWire forms. hCaptcha is a great alternative to Google ReCaptcha, especially if you are in the EU and need to comply with privacy regulations.

      The development of this module is sponsored by schwarzdesign.
      The module is built as an Inputfield, allowing you to integrate it into any ProcessWire form you want. It's primarily intended for frontend forms and can be added to Form Builder forms for automatic spam protection. There's a step-by-step guide for adding the hCaptcha widget to Form Builder forms in the README, as well as instructions for API usage.
      Features
      Inputfield that displays an hCaptcha widget in ProcessWire forms. The inputfield verifies the hCaptcha response upon submission, and adds a field error if it is invalid. All hCaptcha configuration options for the widget (theme, display size etc) can be changed through the inputfield configuration, as well as programmatically. hCaptcha script options can be changed through a hook. Error messages can be translated through ProcessWire's site translations. hCaptcha secret keys and site-keys can be set for each individual inputfield or globally in your config.php. Error codes and failures are logged to help you find configuration errors. Please check the README for setup instructions.
      Links
      Github Repository and documentation InputfieldHCaptcha in the module directory (pending approval) Screenshots (configuration)

      Screenshots (hCaptcha widget)

       
       

       
×
×
  • Create New...