Jump to content
adrian

Tracy Debugger

Recommended Posts

Hey @bernhard and anyone else who might be interested. Following up on my thoughts over here: 

Here's my first test:

cN2HuqqpHQ.gif.2dd012031f190c034de37754f9aaa2f0.gif

 

This comes from a new file which currently contains:

var getCodeSnippets = function() {
    return [
        {
          content: 'd(\\$pages->find("template=\${1:basic-page}")->each("\${2:title}"));',
          name: 'find-pages',
          tabTrigger: 'pwfind'
        }
    ]
};

 

I feel like there needs to be some thought put into how these should work and what the tabTrigger text should be. As you can see this one is about directly d() 'ing, but I am not sure whether it would be more versatile without that wrapping d(). Perhaps we could have both versions?

Maybe we also want something that simply returns:

foreach($pages->find("template=basic-page") as $p) {
    d($p);
}

 

I am really not sure what approach to take here.

Also, do you guys want to contribute snippets to the Tracy core, or would you prefer being able to define your own in a file or in the config settings?

Any thoughts?

Thanks!
 

  • Like 1

Share this post


Link to post
Share on other sites
Quote

or would you prefer being able to define your own in a file or in the config settings? 

Wouldn`t defining your own in a file or in the config settings not be more versatile ? e.g. cross editor compatible

Share this post


Link to post
Share on other sites
15 minutes ago, pwired said:

Wouldn`t defining your own in a file or in the config settings not be more versatile ? e.g. cross editor compatible

Sorry, not sure I understand how this makes things cross editor compatible. 

Honestly I think that all these should probably be in the core. After-all we have the actual snippets panel for you to define and use your own custom ones that others may not find useful.

  • Like 1

Share this post


Link to post
Share on other sites

ACE also comes with a bunch of predefined PHP snippets.

image.png.ff88750ba4cf40080afb8b4e82a77212.png

image.png.034b9b67403a561f549ec843b0c891f3.png

This will all be available in the next release of Tracy.

  • Like 1

Share this post


Link to post
Share on other sites
19 hours ago, bernhard said:

Maybe tracy could even be built a little differently to support 3rd party modules. Just like you did recently with the admin actions module (https://processwire.com/talk/topic/14921-admin-actions/?do=findComment&comment=173496). I'm not requesting this, I'm just thinking out loud here.

Hey @bernhard - sorry I forgot to respond to this before. This is certainly a possibility if there is demand. The advantage of course is that panel authors can maintain the codebase for their panel completely without relying on me to handle PRs etc. The downside is that new Tracy users needs to hunt around to find third-party panels so if we take this approach we'll want to make sure to list them all on a dedicated page on the docs site.

Let me know if anyone out there is interested in this.

Share this post


Link to post
Share on other sites

OK, just released a major new version: 4.12.0

 

1) New Title/View link in Dump tabs, so ID is edit link and title/name is view link

image.png.4e3e74a1eccf862d03727692811409e6.png

 

2) New PagePermissions section added to PW Info panel:

image.png.e67e362f0c591f22edc76a11e9600723.png

 

3) New PHP and custom PW autocomplete snippets added to the Console and File Editor panels. Here's one example, but there are others in the posts prior to this one showing general PHP snippets.

Currently there are two custom PW snippets: pwforeach and pwfind - I'd love to hear what you guys want to see here. If you have new snippet ideas, please take a look at: https://github.com/adrianbj/TracyDebugger/blob/master/scripts/code-snippets.js and feel free to send PRs with new additions.

UPmNZ6c7kf.gif.d0b9e73ed018e3e68fff9876f1e89159.gif

 

4) Ability to dynamically resize the font in the Console and File Editor panels with:

Increase: CTRL + +/=
Decrease: CTRL + -/_
Reset: CTRL + 0

 

5) Changes to the way the Console panel divs are structured and resized - please let me know if you see any issues with the results panel protruding beyond the bottom of the panel or any other issues. It's still not perfect, but it's breaking my brain 🙂

 

6) Some minor Tracy core updates and also general cleanup of many of the custom panels.

 

Please let me know if you have any problems with this new version, or ideas for improvements!

  • Like 5

Share this post


Link to post
Share on other sites
Quote

New PHP and custom PW autocomplete snippets added to the Console and File Editor panels

Thanks fly out for it. Going to edit some of my pages with this and report back.

  • Like 1

Share this post


Link to post
Share on other sites

Great additions as always! Thanks for the tutorial on building panels, I'll try that when I have an idea for something 🙂

9 hours ago, adrian said:

Also, do you guys want to contribute snippets to the Tracy core, or would you prefer being able to define your own in a file or in the config settings?

Any thoughts?

IMHO the best would be to have one shared file in the core and one file specific to each user, because habits are different so I think not all snippets will be helpful to everybody. On the other side it would be great (not to say necessary) to be able to define those snippets somewhere shared across multiple installs of tracy, so that we always have all our snippets available.

I think the best option would be to define a web-url (eg github snippet url to a raw file) and pull this file into the pw cache regularly. Everybody could then just push a new snippet to his git account (or on his webserver) and all tracy installations referencing this file would always be up to date with this file.

If you are happy with that idea I can try to implement that feature and do a PR

  • Like 2

Share this post


Link to post
Share on other sites
17 minutes ago, bernhard said:

I think the best option would be to define a web-url (eg github snippet url to a raw file) and pull this file into the pw cache regularly. Everybody could then just push a new snippet to his git account (or on his webserver) and all tracy installations referencing this file would always be up to date with this file.

I was actually thinking along those lines as well, but I do want to encourage PRs to main file that comes with Tracy as well.

But yeah if you want to add support for pointing to a Github gist URL, or any other URL I suppose, I think that would be a nice addition.

Share this post


Link to post
Share on other sites

I think we should be careful with those snippets. One might find a snippet helpful, another one might find it annoying. If we bloat tracy with snippets it might be counterproductive. I'll see when I find time to dig into that!

  • Like 3

Share this post


Link to post
Share on other sites

Ok, I have implemented the ability to link to your own custom snippets file:

image.thumb.png.8034531982094be4c2829ecdd88a205d.png

If you're using a Github Gist, make sure you use the https://rawgit.com/ service because the raw file from Github is served without the correct mime type and won't work. 

The format of the custom snippet file is like this. Note the getCustomCodeSnippets() compared with the core snippets file which uses getCodeSnippets()

var getCustomCodeSnippets = function() {
    return [
        {
          name: "pwfind",
          content: "d(\\$pages->find(\"template=\${1:basic-page}\")->each(\"\${2:title}\"));",
          tabTrigger: "pwfind"
        },
        {
          name: "pwforeach",
          content: "foreach(\\$pages->find(\"template=\${1:basic-page}\") as \\$p) {\n\td(\\$p);\n}",
          tabTrigger: "pwforeach"
        }
    ]
};

At the moment the custom snippets file is PHP only. I don't think we will ever need other languages for this.


I have also added in the ACE core snippet files for other web related languages so if you use the File Editor panel for JS, CSS, etc, there will now be a bunch of useful snippets for those languages as well.

If you want to peruse the available ACE core snippets, the best way is probably here: https://github.com/ajaxorg/ace/blob/master/lib/ace/snippets/php.snippets 

You can also check out the snippets for other languages in the parent folder of that file.

 

  • Like 3

Share this post


Link to post
Share on other sites
23 minutes ago, adrian said:

What do you guys think of me adding things like this:

To be honest, I would not care too much about it (I guess). I'll have to think of it during further usage of the console. If you implement them, then I'd suggest you implement them in a way that they pull the current api and are always up to date (no idea how hard that would be). Otherwise you'd get plenty of requests to keep everything up to date, I'm afraid. But maybe others think differently...

What annoys me, though, are suggestions like this:

A11PnOr.png

Would it be somehow possible to prevent those suggestions of php functions when I actually want to access an object property/method? Thx

  • Like 1

Share this post


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

If you implement them, then I'd suggest you implement them in a way that they pull the current api and are always up to date (no idea how hard that would be).

Yeah, already done on my dev copy - all PW variables are automatically added to the autocomplete.

bFDXXA2w3E.gif.227e25a80f2a945998748d7021bdadb8.gif

 

8 hours ago, bernhard said:

What annoys me, though, are suggestions like this:

Agreed - I am working on this - I don't necessarily want to disable php autocompletions completely, but trying to tweak the triggering so it's not invasive when you don't want it.

  • Like 2

Share this post


Link to post
Share on other sites

Or perhaps this is even cleaner for the plain PW variables when they are not actually snippets:

3c5rQ1tTEV.gif.9e18aa018f149a4cd18347660d1d104d.gif

Share this post


Link to post
Share on other sites

Also just got this working, all generated automatically from the currently PW install, so it's always up-to-date.

Do you guys think you'd make use of this?

image.png.dfcf093aecb0c631d236908f56df4209.png

  • Like 6

Share this post


Link to post
Share on other sites
Quote

One might find a snippet helpful, another one might find it annoying. If we bloat tracy with snippets it might be counterproductive.

I agree with Bernhard there. The editor should focus on basic and speed. I think that is what is most loved when editing code.

I noticed that this editor has much lesser lag compared to other editors I use who update edited code through ftp. I like the update speed of this editor when you click on save. I also like that it shows hidden formats like empty space and new line to spot any other format that might got in when copying and pasting code from your own snippets.

The Increase: CTRL + works very nice to increase editors font size.

Also like it a lot that the editors window can sticky float anywhere in the backend window.

Quote

I have also added in the ACE core snippet files for other web related languages so if you use the File Editor panel for JS, CSS, etc, there will now be a bunch of useful snippets for those languages as well.

I saw it in action when I was editing some css. I even noticed a little red box with a white cross that indicates typos made when editing. That is just great.

I have been looking a bit for the css where I could change the background of the editor. I assume it is inside the style.css in the module folder. Would also like to style <?php and ?> in blue and bold.

 

Share this post


Link to post
Share on other sites
13 hours ago, pwired said:

I agree with Bernhard there. The editor should focus on basic and speed. I think that is what is most loved when editing code.

Agreed - I don't want either the Console panel or FileEditor panel to slow down at all - I'll make sure that any autocomplete/snippet stuff I add doesn't cause any slowdown.

Glad that in general you enjoy using these tools.

13 hours ago, pwired said:

I have been looking a bit for the css where I could change the background of the editor. I assume it is inside the style.css in the module folder. Would also like to style <?php and ?> in blue and bold.

The best way to change the editor color is to use the built in themes. I actually haven't included any other themes with the Tracy package, but I could easily add these and create a new module config setting so you can choose the theme - there are a lot of options - check out the kitchen sink demo (https://ace.c9.io/build/kitchen-sink.html) and try out the Theme dropdown.

  • Like 1

Share this post


Link to post
Share on other sites
Quote

check out the kitchen sink demo (https://ace.c9.io/build/kitchen-sink.html) and try out the Theme dropdown.

Hi,

I have been fiddling around in the ace-editor folder inside the TracyDebugger module folder
to find a way to change the theme and font size, but without success.

In the kitchen-sink, for the TracyDebugger editor, how can I change the theme-tomorrow_night into IPlastic with font-size 17 ?

 

image.png.8e0a7250d5554c759a66237fa74e97d1.png

 

 

Share this post


Link to post
Share on other sites
3 hours ago, pwired said:

I have been fiddling around in the ace-editor folder inside the TracyDebugger module folder
to find a way to change the theme and font size, but without success.

In the kitchen-sink, for the TracyDebugger editor, how can I change the theme-tomorrow_night into IPlastic with font-size 17 ?

I haven't packaged the other themes with Tracy yet, but I can do so if you guys are interested. I initially went with just one theme (my favorite) because I wasn't sure how much use the Console and File Editor panels would get, but given their popularity I think it probably makes sense to include all the themes so you guys can choose what you prefer.

I guess the next question is to figure out whether you guys want to be able to adjust all ACE editor settings via a textarea with key:value pairs or whether I should provide the key settings I think you might want to adjust as dedicated fields in the module settings like I have with the tab size, type and show invisibles settings. What does everyone think?

  • Like 1

Share this post


Link to post
Share on other sites

Is this going too far having the doc comment displayed? It's a good learning tool. Maybe make it optional, or do you guys think just leave it out completely?

qtY05Agimd.thumb.gif.d6c3a62727ebce59e8d27b2ae00efdfa.gif

  • Like 1

Share this post


Link to post
Share on other sites
Quote

I haven't packaged the other themes with Tracy yet, but I can do so if you guys are interested.

The TracyDebugger editor can sticky float anywhere and has a full screen toggle which makes it very practical,
so I guess more people are going to pick it up.
Would be nice to have a few themes because everybody experiences different colors as hard colors for the eyes to work with.
Is it difficult to port an Ace theme to TracyDebugger ? Maybe I can help with something ?

  • Like 1

Share this post


Link to post
Share on other sites
2 hours ago, pwired said:

Is it difficult to port an Ace theme to TracyDebugger ? Maybe I can help with something ?

Thanks but it's super easy. Just before I do I need to decide how to facilitate the various Ace settings like I mentioned above. 

  • Like 1

Share this post


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

I haven't packaged the other themes with Tracy yet, but I can do so if you guys are interested.

It doesn't look like they are massive (size), so, maybe yes, one or two more. I'm happy with the dark theme, so I am biased 🙂.

  • Like 3

Share this post


Link to post
Share on other sites
Quote

It doesn't look like they are massive (size), so, maybe yes, one or two more.

I think Kongondo has a point there. To prevent bloat creeping in, maybe it would be an idea to leave it up to the user which theme to get inside the ace-editor folder ?

In the ace-editor folder I noticed the file: theme-tomorrow_night.js

Just the possibility to let users change this file manually into another one e.g. theme-iplastic.js, and also manually edit font size, maybe that would be a bloat free solution ?

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...