adrian

Tracy Debugger

Recommended Posts

Hi @bernhard - I have upped them to 9999 here locally - I'll commit it to the next version.

Hi @rick - that might be possible, but I am curious about why you want this - for me it's about quickly and temporarily getting every Tracy related hidden so I can see what's behind on the main page content. 

  • Thanks 1

Share this post


Link to post
Share on other sites

When I have a panel maximized, sometimes the 3 or 4 lines of the tracy bar cover some content. It's no biggie, I just expected the panel to remain in view and surprised me when it kept closing after minimizing the toolbar.

 

Share this post


Link to post
Share on other sites
On 8/10/2018 at 11:24 AM, rick said:

When I have a panel maximized, sometimes the 3 or 4 lines of the tracy bar cover some content. It's no biggie, I just expected the panel to remain in view and surprised me when it kept closing after minimizing the toolbar.

Typically the simple solution for this would be to drag the Tracy debug bar out of the way - this will work so long as you don't have the "Fixed Position" option checked in the config settings.

 

Share this post


Link to post
Share on other sites

Hi everyone - @netcarver has mentioned to me that he's not a fan of some of the ambiguity of the icon colors in the debug bar - mostly the blue for the System Info icon and the PW pink color used by the PW Info and Captain Hook panels, and the purple used by the PHP Info panel. I have quickly mocked up a version where these are all grey:

image.thumb.png.523ac587c1e3956e5d7715c3fed14eff.png

He wanted me to poll you guys to get some input on this change and also any other changes you might like to see. 

In general the idea with icon colors is:

grey - no significance
green - everything ok - no attention needed
orange - warning or attention to a new entry/item of interest
red - warning, fail, or something else that you should be aware of

So please post your thoughts - what do you think can be done to make it look cleaner and also more meaningful/useful?

Thanks!

  • Like 2
  • Thanks 2

Share this post


Link to post
Share on other sites
1 hour ago, adrian said:

In general the idea with icon colors is:

grey - no significance
green - everything ok - no attention needed
orange - warning or attention to a new entry/item of interest
red - warning, fail, or something else that you should be aware of

I haven't found the icons ambiguous so far, but the colour scheme you're suggesting sounds like it would be a good enhancement.

  • Like 1

Share this post


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

I haven't found the icons ambiguous so far, but the colour scheme you're suggesting sounds like it would be a good enhancement.

+1

  • Like 1

Share this post


Link to post
Share on other sites

Just to clarify my request to Adrian, it's not the icons that I'm finding ambiguous - there's nothing wrong with them IMO - it's what the colours are signalling in the current version of Tracy that I find a little confusing.

This is what I'm trying to avoid - particularly the part between 24 and 43 seconds...

Here's the current state of play...

screeny-0049.png.d1efee3239fdf9e9fdbd91afa7b79617.png

To me - with my now aging eyes - the colours of...

  • 2, 5 & 7 seem to be signalling an error condition or something that needs my attention and that this icon could be another colour when the error is sorted out.
  • 3, D & H are warning me of something and these icons could be another colour at other times.
  • 4, 6, 8, 9, A, (all the green ones) have no error - but they could have warnings or errors at other times.
  • All the grey ones are - well, I don't know - are they OK? Or Off? Or just buttons to press when I need them?
  • 1 & F are signalling something else to me that's different to all the above.

Whilst some of the above is correct, I don't think it's clear in the current incarnation.

I also think that the decision to colour some icons green rather than grey when there are no warnings or errors, might, arguably, need revisiting. (For example - I think B (Mail interceptor) and C (Module switcher) would probably be better as Grey in the above if there is no interception or disabling going on.)

Basically I'd like to have Tracy only use non-grey colour signalling to me if there is something that needs my attention or constant reminder. I think that would stop me feeling a little like Richmond from the IT Crowd.

BTW - I'm not dishing Tracy or the work Adrian's put in. I think one of the top modules there are for PW and I'm very pleased that Adrian's produced it and for all the hard work he's put in on it.

Hope that clarifies where I'm coming from,
Steve

 

  • Like 4

Share this post


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

grey - no significance
green - everything ok - no attention needed
orange - warning or attention to a new entry/item of interest
red - warning, fail, or something else that you should be aware of

Sounds great, just one question: how will you decide which "warning color" to use, orange vs red? I guess red should not be used for warnings at all. On the same account: "something else that you should be aware of" will be "fail / error / you-MUST-be-aware-of", right?

Share this post


Link to post
Share on other sites

I just wanted to clarify that the grey/green/orange/red color scheme is already in place and has been since the beginning of the module. As per my mockup above I am more than happy to make all the icons that don't need this scheme grey instead of PW pink or PHP purple, or blue (the System Info icon). Hopefully we're all good with that change.

7 hours ago, netcarver said:

I also think that the decision to colour some icons green rather than grey when there are no warnings or errors, might, arguably, need revisiting. (For example - I think B (Mail interceptor) and C (Module switcher) would probably be better as Grey in the above if there is no interception or disabling going on.)

Basically I'd like to have Tracy only use non-grey colour signalling to me if there is something that needs my attention or constant reminder. I think that would stop me feeling a little like Richmond from the IT Crowd.

I think this approach of grey instead of green to indicate no attention needed will be fine - I can't currently see any reason not to make this change. 

 

4 hours ago, szabesz said:

just one question: how will you decide which "warning color" to use, orange vs red? I guess red should not be used for warnings at all.

I think there will always be some difficulties in determining what should be orange and what should be red, although I do think that if we get rid of green altogether it will actually be simpler, for example I always felt a bit weird about debug mode set to on resulting in red. I think a new grey / orange only combo is probably much nicer. Orange being a warning that you need to be aware of the fact that it's on and this is a security concern on a live site.

 

8 hours ago, netcarver said:

BTW - I'm not dishing Tracy or the work Adrian's put in. I think one of the top modules there are for PW and I'm very pleased that Adrian's produced it and for all the hard work he's put in on it.

No problem at all - as with most things, Tracy has evolved and wasn't really planned from the beginning, so more than happy to revisit this stuff now and I really appreciate everyone's input.

  • Like 3

Share this post


Link to post
Share on other sites

Also, if there are any icon geeks out there, I'd love some help to revamp the icons on the debug bar - many of them are very ugly 🙂 

Any takers?

Share this post


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

Any takers?

I can do it on a one-by-one basis. Not too much free time these days but if we are not in a hurry... 🙂 

  • Like 2

Share this post


Link to post
Share on other sites
3 minutes ago, szabesz said:

I can do it on a one-by-one basis. Not too much free time these days but if we are not in a hurry... 🙂 

Sounds good - I don't think you need to go creating them - probably just need to spend some time looking around for better free ones, but whatever you think would be great.

I think regardless of how you go about creating or finding them we should wait till you have them all ready before committing any changes.

  • Like 2

Share this post


Link to post
Share on other sites

Just the default icons to give you guys an idea, but how's this looking?

image.png.46fba262511a7dabcee0bc52d56c8aff.png

Still not sure if Debug Mode icon on should be orange or red?

Perhaps I should check if on local dev or live server and go with grey for the former and red for the latter where it really is important!

  • Like 2

Share this post


Link to post
Share on other sites
Posted (edited)
1 hour ago, adrian said:

local dev or live server and go with grey for the former and red for the latter

+1

2 hours ago, adrian said:

Sounds good - I don't think you need to go creating them - probably just need to spend some time looking around for better free ones, but whatever you think would be great.

I think regardless of how you go about creating or finding them we should wait till you have them all ready before committing any changes.

I don wanna reinvent the wheel 🙂 but even free ones should be used as starting points only and most importantly they must look like one family, so that is where most efforts should be put into (besides pleasing the eye, of course...).

Edited by szabesz
typo
  • Like 1

Share this post


Link to post
Share on other sites

New version just committed contains all the icon color changes. Mostly it's just consolidating the default color to grey and changing a few instances of when orange (WARN) vs red (ALERT) is used.

Let me know if you find anything I have missed or any inconsistencies.

image.thumb.png.a70e0d1703859d163101324b5a2370d4.png 

  • Like 5

Share this post


Link to post
Share on other sites

thanks - already using it and i like it! 🙂 

  • Like 1

Share this post


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

thanks - already using it and i like it! 🙂 

Thanks!

Also, just an FYI that your bdb and db 999 has been changed to 9999 in that version.

  • Thanks 1

Share this post


Link to post
Share on other sites
1 minute ago, adrian said:

Also, just an FYI that your bdb and db 999 has been changed to 9999 in that version.

Thank you. Actually I came up with a somewhat different idea. I had to debug something yesterday and needed ['debugInfo' => false] several times. In fact I need it that often that I can even remember it by heart 😄 

My Idea: What if we had a bdv() method instead of bdb, meaning barDumpVerbose() that has a limit of 9999 AND debuginfo set to false?

Share this post


Link to post
Share on other sites
1 minute ago, bernhard said:

Thank you. Actually I came up with a somewhat different idea. I had to debug something yesterday and needed ['debugInfo' => false] several times. In fact I need it that often that I can even remember it by heart 😄 

My Idea: What if we had a bdv() method instead of bdb, meaning barDumpVerbose() that has a limit of 9999 AND debuginfo set to false?

I am getting a little annoyed with the debugInfo output myself actually - there are lots of holes in it's output - there is a bit of a discussion about it here: https://github.com/processwire/processwire-issues/issues/575 but it would be a lot of work for Ryan to go through all of PW and set this up properly. 

Of course there is a config setting to make the default behavior show the full PW object, but there are times when the debugInfo output is better/easier.

I mentioned above somewhere that I was thinking about having an option to dump both versions automatically with any dump/bardump call - best of both worlds. What do you think about this as an alternative?

Not saying I don't like the verbose idea - I just want to make sure we don't end up with more options than we need. It might also be confusing if you already have debugInfo off by default in the config settings. I don't know - anyone else have any thoughts?

  • Like 2

Share this post


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

I mentioned above somewhere that I was thinking about having an option to dump both versions automatically with any dump/bardump call - best of both worlds. What do you think about this as an alternative?

not sure how that should look like exactly but it sounds good to me 🙂

  • Like 2

Share this post


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

New version just committed contains all the icon color changes. Mostly it's just consolidating the default color to grey and changing a few instances of when orange (WARN) vs red (ALERT) is used.

Let me know if you find anything I have missed or any inconsistencies.

image.thumb.png.a70e0d1703859d163101324b5a2370d4.png 

Thank you for working on this, Adrian. Looks a lot clearer now.

  • Like 3

Share this post


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

I mentioned above somewhere that I was thinking about having an option to dump both versions automatically with any dump/bardump call - best of both worlds. What do you think about this as an alternative?

not sure how that should look like exactly but it sounds good to me 🙂

Would it mean that we have to click twice to see one of them? First a click on the arrow next to the class name, after that another click on either debugInfo or PW object? Or maybe you "extend" debug info and PW object gets injected into it?

Either way, I think it would be nice to see the id of a Page object without clicking on anything, somewhere between the class name and the arrow. Is that possible?

Share this post


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

New version just committed contains all the icon color changes. Mostly it's just consolidating the default color to grey and changing a few instances of when orange (WARN) vs red (ALERT) is used.

Let me know if you find anything I have missed or any inconsistencies.

image.thumb.png.a70e0d1703859d163101324b5a2370d4.png 

I think non-grey default icons would look nicer, eg. a darker blue like #354B60 (borrowed from the Uikit admin theme).

tracysvgicons.png.4bd4c5241745b78c8c8a8f3b19bd811c.png

It's just a quick devtools preview but for me the current grey is too pale, and rather suggests that those icons are in an "off" state.

To further complicate things, here is an inverted version where the whole bar is blue and icons/texts are white:

tracysvgicons-invert.png.55458fbc83752f44e9cf2a898f1714ed.png

I'm not sure this would be better but wanted to share. The biggest advantage would be that it would pop out more from the rest of the page. Orange and red icons would require some brightening to be more visible though.

  • Like 4

Share this post


Link to post
Share on other sites
8 minutes ago, tpr said:

I'm not sure this would be better but wanted to share. The biggest advantage would be that it would pop out more from the rest of the page. Orange and red icons would require some brightening to be more visible though.

I like both actually - the first option really does look a lot nicer than the grey which is pretty awful now that I see the difference 🙂

The second one is nice but you're right, it will be problematic for the orange and red icons.

Anyone have any thoughts?

 

1 hour ago, szabesz said:

Would it mean that we have to click twice to see one of them? First a click on the arrow next to the class name, after that another click on either debugInfo or PW object? Or maybe you "extend" debug info and PW object gets injected into it?

Either way, I think it would be nice to see the id of a Page object without clicking on anything, somewhere between the class name and the arrow. Is that possible?

Not sure yet - I don't think I can hook into debugInfo though - I'll see what I can do about this sometime soon.

Share this post


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

grey which is pretty awful now that I see the difference

So did I on my very old designs 🙂

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 BitPoet
      MediaLibrary
      Update: MediaLibrary can now be found in the official module list.
      Out of necessity, I've started to implement a simple media library module.
      The basic mechanism is that it adds a MediaLibrary template with file and image fields. Pages of this type can be added anywhere in the page tree.
      The link and image pickers in CKEditor are extended to allow quick selection of library pages from dropdowns. In the link picker this happens in the MediaLibrary tab, where you can also see a preview of the selected image. In the image picker, simply select a library from the dropdown at the top, everything else is handled by standard functionality.
      I've put the code onto github. This module is compatible with ProcessWire 3.
      Steps to usage:
      Download the module's zip from github (switch to the pw3 branche beforehand if you want to test on PW 3.x) and unpack it into site/modules Click "Modules" -> "Refresh" in the admin Click "Install" for MediaLibrary For testing, create a page with the MediaLibrary template under home (give it an expressive title like 'Global Media') and add some images and files Edit a differnt page with a CKEditor field and add a link and an image to see the MediaLibrary features in action (see the screencap for details) Optionally, go into the module settings for MediaLibrary Note: this module is far from being as elaborate as Kongondo's Media Manager (and doesn't plan to be). If you need a feature-rich solution for integrated media management, give it a look.
      Feel free to change the settings for MediaFiles and MediaImages fields, just keep the type as multiple.
      There are some not-so-pretty hacks for creating and inserting the correct markup, which could probably be changed to use standard input fields, though I'm a bit at a loss right now how to get it to work. I've also still got to take a look at error handling before I can call it fit for production. All feedback and pointers are appreciated (that's also why I post this in the development section).

      Edit 09.03.2016 / version 0.0.4: there's now also a "Media" admin page with a shortcut to quickly add a new library.

      Edit 01.05.2016:
      Version 0.0.8:
      - The module now supports nested media libraries (all descendants of eligible media libraries are also selectable in link/image picker).
      - There's a MediaLibrary::getPageMediaLibraries method you can hook after to modify the array of available libraries.
      - You can switch between (default) select dropdowns or radio boxes in the module configuration of MediaLIbrary to choose libraries.
      Edit 10.10.2018:
      Version 0.1.3:
      - Dropped compatibility for ProcessWire legacy versions by adding namespaces
      - Allow deletion of libraries from the Media overview admin page
      - Added an option to hide media libraries from the page tree (optionally also for superusers)
    • By Robin S
      This module corrects a few things that I find awkward about the "Add New Template" workflow in the PW admin. I opened a wishlist topic a while back because it would good to resolve some of these things in the core, but this module is a stopgap for now.
      Originally I was going to share these as a few standalone hooks, but decided to bundle them together in a configurable module instead.
      Add Template Enhancements
      A module for ProcessWire CMS/CMF. Adds some efficiency enhancements when adding or cloning templates via admin.

      Features
      Derive label from name when new template added: if you like to give each of your templates a label then this feature can save some time. The label can be added automatically when templates are added in admin, in admin/API, or not at all. There are options for underscore/hyphen replacement and capitalisation of the label. Edit template after add: when adding only a single template, the template is automatically opened for editing after it is added. Copy field contexts when cloning: this copies the field contexts (a.k.a. overrides such as column width, label and description) from the source template to the new template when using the "Duplicate/clone this template?" feature on the Advanced tab. Copy field contexts when duplicating fields: this copies the field contexts if you select the "Duplicate fields used by another template" option when adding a new template. Usage
      Install the Add Template Enhancements module.
      Configure the module settings according to what suits you.
       
      https://github.com/Toutouwai/AddTemplateEnhancements
      https://modules.processwire.com/modules/add-template-enhancements/
    • By Mike Rockett
      As I mentioned in this issue, I've create a new textformatter for ParsedownExtraPlugin, which adds some oomph to your markdown.
      Repo: Parsedown Extra Plugin
      Unlike the built-in textformatter for Parsedown and Parsedown Extra, this should be used when you want to use Extra with additional configuration/customisation.
      Some examples:
      ### Test {.heading} - A [external link](https://google.com/){.google} with `google` as a class that opens in a new tab if the config property is set. - [Another link](/page){target=_blank} that opens in a new tab even though it isn't external. ```html .html <p>Test</p> ``` There's some config options available to you, such as setting attributes on all/external images and links, setting table and table-cell alignment classes, adjusting footnote classes and IDs, adding <code> attributes to their parent <pre> elements, and changing the <code> class if your syntax highlighter does not use language-*.
      I was thinking about adding the ability to make links open in a new tab by appending a plus to the link syntax, but only external links should be opening in a new tab anyway. Further, this would add extra, unnecessary processing time.
      Please let me know if you bump into any problems. ☺️
    • By Mike Rockett
      TextformatterTypographer (0.4.0 Beta)
      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.
      Learn more on my blog
      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.
      Please do test it out and let me know what you think.
      Also note that I have indicated support for PW 2.8, but I haven't tested there as yet. This was built on PW 3.0.42/62.
    • By Mike Rockett
      Jumplinks for ProcessWire
      Release: 1.5.50
      Jumplinks is an enhanced version of the original ProcessRedirects by Antti Peisa.
      The Process module manages your permanent and temporary redirects (we'll call these "jumplinks" from now on, unless in reference to redirects from another module), useful for when you're migrating over to ProcessWire from another system/platform. Each jumplink supports wildcards, shortening the time needed to create them.
      Unlike similar modules for other platforms, wildcards in Jumplinks are much easier to work with, as Regular Expressions are not fully exposed. Instead, parameters wrapped in curly braces are used - these are described in the documentation.
      Under Development: 2.0, to be powered by FastRoute
      As of version 1.5.0, Jumplinks requires at least ProcessWire 2.6.1 to run.
      View on GitLab
      Download via the Modules Directory
      Read the docs
      Features
      The most prominent features include:
      Basic jumplinks (from one fixed route to another) Parameter-based wildcards with "Smart" equivalents Mapping Collections (for converting ID-based routes to their named-equivalents without the need to create multiple jumplinks) Destination Selectors (for finding and redirecting to pages containing legacy location information) Timed Activation (activate and/or deactivate jumplinks at specific times) 404-Monitor (for creating jumplinks based on 404 hits) Additionally, the following features may come in handy:
      Stale jumplink management Legacy domain support for slow migrations An importer (from CSV or ProcessRedirects) Feedback & Feature Requests
      I’d love to know what you think of this module. Please provide some feedback on the module as a whole, or even regarding smaller things that make it whole. Also, please feel free to submit feature requests and their use-cases.
      Note: Features requested so far have been added to the to-do list, and will be added to 2.0, and not the current dev/master branches.
      Open Source

      Jumplinks is an open-source project, and is free to use. In fact, Jumplinks will always be open-source, and will always remain free to use. Forever. If you would like to support the development of Jumplinks, please consider making a small donation via PayPal.
      Enjoy!