Jump to content
benbyf

New module MarkInPageTree

Recommended Posts

MarkInPageTree

New module which does what it says in the title. It adds an icon to a page on the page tree if -> a specific field is true and / or is a specified template.

For example I'm using it to add an icon to any page that has a checked (checkbox) exclusive field. This helps with admin clarity as you can see instantly which pages of the same template have differing content (i.e. are exclusive or not).

https://github.com/benbyford/MarkInPageTree

Screenshot 2016-12-09 14.33.45.png

  • Like 10

Share this post


Link to post
Share on other sites

How about using InputfieldSelector for the page selection and using InputfieldIcon for the icon selection?

  • Like 2

Share this post


Link to post
Share on other sites
Just now, LostKobrakai said:

How about using InputfieldSelector for the page selection and using InputfieldIcon for the icon selection?

Sure, how does one do that :)

Share this post


Link to post
Share on other sites

couldnt work it out, just gave me a field for searching the pages on the site but not selecting them... and it wouldnt show templates or fields.

I was able to use select multiple instead thought. For example:

$f = $this->modules->get('InputfieldSelectMultiple');
$f->attr('name', 'template');
$f->description =  $this->_("Template or templates of pages to trigger bulk email to users after new page published");
$f->addOption('', '');

foreach($this->templates as $template){
$f->addOption($template->name, $template->title);

 

Share this post


Link to post
Share on other sites

Updated and works well (needed to delete the extra fa- in the html as the icon selector adds the complete fontawesome name). Only thing I would change but unsure is whether you can have or selector somehow as it currenlty only adds icons to the selectors found pages not a template or a field for example. i.e. for mulitple selectors.

Share this post


Link to post
Share on other sites

Great idea and great module! Saves me some rather ugly additions to the displayed title page in the page tree.

One thing for the Christmas wish list: It would be even greater if the module would provide a way to set up several different rule sets. So you could set up different icons to mark different things.

  • Like 2

Share this post


Link to post
Share on other sites

not really sure how to make this happen... repeater? Anyone point me in the right direction to creating multiple additional fields to the module settings? so the module can have as many icon and template or field pairs as you want...?

Share this post


Link to post
Share on other sites

Multi-value fields in module config is a bit tricky, because almost everything multi-value in pw is based on pages, which you don't use here. It's probably simplest to add an integer field "number_of_configuration", which does, after it's saved, cause the field(s) for the page selection to be rendered that many times. In your modules code you'd also use that number for determining how often to loop though potential configurations.

Share this post


Link to post
Share on other sites

I would go with the "icon name = selector" route, in a simple textarea, one rule per row. Icon name would be the fontawesome name.

  • Like 2

Share this post


Link to post
Share on other sites

Happy Christmas everyone!

I had a bit of time to add tot his module :)

It now has textareas (thanks @tpr) in it's config which means it can now add as many icons and field and/or template pairs as you like. This means you could add one icon for pages of the template basic-page, and also add another icon for all pages with a counter etc...

Also... I've added a third textarea, allowing you to add a list of fields to show the data for IN the pagetree itself (see image below). In my example below I am able to show in the page tree by each page if they have a counter what the data is and whether the page has a field exclusive and its data.

Thanks for peoples help and hope it is useful. (updated on github)

Screenshot 2016-12-17 15.43.47.png

Screenshot 2016-12-17 15.43.27.png

  • Like 5

Share this post


Link to post
Share on other sites

Thanks for sharing your module with us. I use it to mark events which are booked up.

  • Like 3

Share this post


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

Hello @benbyf

can you check the following message:

Screenshot_2.jpg

Thanks!

when are you getting this error? can you send me your settings. thanks

Share this post


Link to post
Share on other sites

No its a notice - it only shows up  as an error because I am running Tracy in strict mode.

These are my settings:

Screenshot_3.jpg

  • Like 1

Share this post


Link to post
Share on other sites

As a quick patch this fixes the error:

Change this:

$a[trim($cropItems[1])] = trim($cropItems[0]);

 

To this:

if(count($cropItems) > 1){
	$a[trim($cropItems[1])] = trim($cropItems[0]);
}

 

  • Like 1

Share this post


Link to post
Share on other sites

Thanks, and glad you're finding the module useful.

If you have any other bugs or fixes, please submit a issue or pull request on github

Share this post


Link to post
Share on other sites

Hi,

Thanks for this module, it's quite useful, and it's work very well. However, I still wondering which icons I can use? I can't find anywhere a list or a reference to an iconset used by the module. 

Mel

Share this post


Link to post
Share on other sites

Great module, thank you!

Is there a way to use separate variations of icons, e.g. "fas fa-check" vs. "far fa-check"?

P.S.: You might want to point to the icon cheatsheet in the module description. I was confused as well (newbie).

Share this post


Link to post
Share on other sites
On 9/7/2018 at 10:34 AM, Knubbi said:

Great module, thank you!

Is there a way to use separate variations of icons, e.g. "fas fa-check" vs. "far fa-check"?

P.S.: You might want to point to the icon cheatsheet in the module description. I was confused as well (newbie).

Both valid. PW comes with Fontawesome in the default admin so thats why its the deafult far icons. If you want to purchase new icons versions and replaces the files in your copy then that shoul work.

Will definitely change the description.

  • Like 1

Share this post


Link to post
Share on other sites

Hi Benbyf,

I'm really enjoying this module.  It really helps visualize how the page tree relates to the templates.  I'm using "template" in Data.

One request: It would be really helpful if you could add a permission so that only super users see the MarkInPageTree stuff in the Page Tree by default.  If other roles need to see the MarkInPageTree stuff in the Page Tree, a site admin could add a MarkInPageTree permission to that role.

The only caveat is that existing sites that have already installed this module will need to be updated to use the new permission.

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 teppo
      Needed a really simple solution to embed audio files within page content and couldn't find a module for that, so here we go. Textformatter Audio Embed works a bit like Textformatter Video Embed, converting this:
      <p>https://www.domain.tld/path/to/file.mp3</p> Into this:
      <audio controls class="TextformatterAudioEmbed"> <source src="https://www.domain.tld/path/to/file.mp3" type="audio/mpeg"> </audio> The audio element has pretty good browser support, so quite often this should be enough to get things rolling 🙂
      GitHub repository: https://github.com/teppokoivula/TextformatterAudioEmbed Modules directory: https://modules.processwire.com/modules/textformatter-audio-embed/
    • By Richard Jedlička
      Tense    
      Tense (Test ENvironment Setup & Execution) is a command-line tool to easily run tests agains multiple versions of ProcessWire CMF.
      Are you building a module, or a template and you need to make sure it works in all supported ProcessWire versions? Then Tense is exactly what you need. Write the tests in any testing framework, tell Tense which ProcessWire versions you are interested in and it will do the rest for you.

      See example or see usage in a real project.
      How to use?
      1. Install it: 
      composer global require uiii/tense 2. Create tense.yml config:
      tense init 3. Run it:
      tense run  
      For detailed instructions see Github page: https://github.com/uiii/tense
       
      This is made possible thanks to the great wireshell tool by @justb3a, @marcus and others.
       
      What do you think about it? Do you find it useful? Do you have some idea? Did you find some bug? Tell me you opinion. Write it here or in the issue tracker.
    • By Chris Bennett
      Hi all, I am going round and round in circles and would greatly appreciate if anyone can point me in the right direction.
      I am sure I am doing something dumb, or missing something I should know, but don't. Story of my life 😉

      Playing round with a module and my basic problem is I want to upload an image and also use InputfieldMarkup and other Inputfields.
      Going back and forth between trying an api generated page defining Fieldgroup, Template, Fields, Page and the InputfieldWrapper method.

      InputfieldWrapper method works great for all the markup stuff, but I just can't wrap my head around what I need to do to save the image to the database.
      Can generate a Field for it (thanks to the api investigations) but not sure what I need to do to link the Inputfield to that. Tried a lot of stuff from various threads, of varying dates without luck.
      Undoubtedly not helped by me not knowing enough.

      Defining Fieldgroup etc through the api seems nice and clean and works great for the images but I can't wrap my head around how/if I can add/append/hook the InputfieldWrapper/InputfieldMarkup stuff I'd like to include on that template as well. Not even sure if it should be where it is on ___install with the Fieldtype stuff or later on . Not getting Tracy errors, just nothing seems to happen.
      If anyone has any ideas or can point me in the right direction, that would be great because at the moment I am stumbling round in the dark.
       
      public function ___install() { parent::___install(); $page = $this->pages->get('name='.self::PAGE_NAME); if (!$page->id) { // Create fieldgroup, template, fields and page // Create new fieldgroup $fmFieldgroup = new Fieldgroup(); $fmFieldgroup->name = MODULE_NAME.'-fieldgroup'; $fmFieldgroup->add($this->fields->get('title')); // needed title field $fmFieldgroup->save(); // Create new template using the fieldgroup $fmTemplate = new Template(); $fmTemplate->name = MODULE_NAME; $fmTemplate->fieldgroup = $fmFieldgroup; $fmTemplate->noSettings = 1; $fmTemplate->noChildren = 1; $fmTemplate->allowNewPages = 0; $fmTemplate->tabContent = MODULE_NAME; $fmTemplate->noChangeTemplate = 1; $fmTemplate->setIcon(ICON); $fmTemplate->save(); // Favicon source $fmField = new Field(); $fmField->type = $this->modules->get("FieldtypeImage"); $fmField->name = 'fmFavicon'; $fmField->label = 'Favicon'; $fmField->focusMode = 'off'; $fmField->gridMode = 'grid'; $fmField->extensions = 'svg png'; $fmField->columnWidth = 50; $fmField->collapsed = Inputfield::collapsedNever; $fmField->setIcon(ICON); $fmField->addTag(MODULE_NAME); $fmField->save(); $fmFieldgroup->add($fmField); // Favicon Silhouette source $fmField = new Field(); $fmField->type = $this->modules->get("FieldtypeImage"); $fmField->name = 'fmFaviconSilhouette'; $fmField->label = 'SVG Silhouette'; $fmField->notes = 'When creating a silhouette/mask svg version for Safari Pinned Tabs and Windows Tiles, we recommend setting your viewbox for 0 0 16 16, as this is what Apple requires. In many cases, the easiest way to do this in something like illustrator is a sacrificial rectangle with no fill, and no stroke at 16 x 16. This forces the desired viewbox and can then be discarded easily using something as simple as notepad. Easy is good, especially when you get the result you want without a lot of hassle.'; $fmField->focusMode = 'off'; $fmField->extensions = 'svg'; $fmField->columnWidth = 50; $fmField->collapsed = Inputfield::collapsedNever; $fmField->setIcon(ICON); $fmField->addTag(MODULE_NAME); $fmField->save(); $fmFieldgroup->add($fmField); // Create: Open Settings Tab $tabOpener = new Field(); $tabOpener->type = new FieldtypeFieldsetTabOpen(); $tabOpener->name = 'fmTab1'; $tabOpener->label = "Favicon Settings"; $tabOpener->collapsed = Inputfield::collapsedNever; $tabOpener->addTag(MODULE_NAME); $tabOpener->save(); // Create: Close Settings Tab $tabCloser = new Field(); $tabCloser->type = new FieldtypeFieldsetClose; $tabCloser->name = 'fmTab1' . FieldtypeFieldsetTabOpen::fieldsetCloseIdentifier; $tabCloser->label = "Close open tab"; $tabCloser->addTag(MODULE_NAME); $tabCloser->save(); // Create: Opens wrapper for Favicon Folder Name $filesOpener = new Field(); $filesOpener->type = new FieldtypeFieldsetOpen(); $filesOpener->name = 'fmOpenFolderName'; $filesOpener->label = 'Wrap Folder Name'; $filesOpener->class = 'inline'; $filesOpener->collapsed = Inputfield::collapsedNever; $filesOpener->addTag(MODULE_NAME); $filesOpener->save(); // Create: Close wrapper for Favicon Folder Name $filesCloser = new Field(); $filesCloser->type = new FieldtypeFieldsetClose(); $filesCloser->name = 'fmOpenFolderName' . FieldtypeFieldsetOpen::fieldsetCloseIdentifier; $filesCloser->label = "Close open fieldset"; $filesCloser->addTag(MODULE_NAME); $filesCloser->save(); // Create Favicon Folder Name $fmField = new Field(); $fmField->type = $this->modules->get("FieldtypeText"); $fmField->name = 'folderName'; $fmField->label = 'Favicon Folder:'; $fmField->description = $this->config->urls->files; $fmField->placeholder = 'Destination Folder for your generated favicons, webmanifest and browserconfig'; $fmField->columnWidth = 100; $fmField->collapsed = Inputfield::collapsedNever; $fmField->setIcon('folder'); $fmField->addTag(MODULE_NAME); $fmField->save(); $fmFieldgroup->add($tabOpener); $fmFieldgroup->add($filesOpener); $fmFieldgroup->add($fmField); $fmFieldgroup->add($filesCloser); $fmFieldgroup->add($tabCloser); $fmFieldgroup->save(); /////////////////////////////////////////////////////////////// // Experimental Markup Tests $wrapperFaviconMagic = new InputfieldWrapper(); $wrapperFaviconMagic->attr('id','faviconMagicWrapper'); $wrapperFaviconMagic->attr('title',$this->_('Favicon Magic')); // field show info what $field = $this->modules->get('InputfieldMarkup'); $field->name = 'use'; $field->label = __('How do I use it?'); $field->collapsed = Inputfield::collapsedNever; $field->icon('info'); $field->attr('value', 'Does this even begin to vaguely work?'); $field->columnWidth = 50; $wrapperFaviconMagic->add($field); $fmTemplate->fields->add($wrapperFaviconMagic); $fmTemplate->fields->save(); ///////////////////////////////////////////////////////////// // Create page $page = $this->wire( new Page() ); $page->template = MODULE_NAME; $page->parent = $this->wire('pages')->get('/'); $page->addStatus(Page::statusHidden); $page->title = 'Favicons'; $page->name = self::PAGE_NAME; $page->process = $this; $page->save(); } }  
    • By Sebi
      Since it's featured in ProcessWire Weekly #310, now is the time to make it official:
      Here is Twack!
      I really like the following introduction from ProcessWire Weekly, so I hope it is ok if I use it here, too. Look at the project's README for more details!
      Twack is a new — or rather newish — third party module for ProcessWire that provides support for reusable components in an Angular-inspired way. Twack is implemented as an installable module, and a collection of helper and base classes. Key concepts introduced by this module are:
      Components, which have separate views and controllers. Views are simple PHP files that handle the output for the component, whereas controllers extend the TwackComponent base class and provide additional data handling capabilities. Services, which are singletons that provide a shared service where components can request data. The README for Twack uses a NewsService, which returns data related to news items, as an example of a service. Twack components are designed for reusability and encapsulating a set of features for easy maintainability, can handle hierarchical or recursive use (child components), and are simple to integrate with an existing site — even when said site wasn't originally developed with Twack.
      A very basic Twack component view could look something like this:
      <?php namespace ProcessWire; ?> <h1>Hello World!</h1> And here's how you could render it via the API:
      <?php namespace Processwire; $twack = $modules->get('Twack'); $hello = $twack->getNewComponent('HelloWorld'); ?> <html> <head> <title>Hello World</title> </head> <body> <?= $hello->render() ?> </body> </html> Now, just to add a bit more context, here's a simple component controller:
      <?php namespace ProcessWire; class HelloWorld extends TwackComponent { public function __construct($args) { parent::__construct($args); $this->title = 'Hello World!'; if(isset($args['title'])) { $this->title = $args['title']; } } } As you can see, there's not a whole lot new stuff to learn here if you'd like to give Twack a try in one of your projects. The Twack README provides a really informative and easy to follow introduction to all the key concepts (as well as some additional examples) so be sure to check that out before getting started. 
      Twack is in development for several years and I use it for every new project I build. Also integrated is an easy to handle workflow to make outputs as JSON, so it can be used to build responses for a REST-api as well. I will work that out in one section in the readme as well. 
      If you want to see the module in an actual project, I have published the code of www.musical-fabrik.de in a repository. It runs completely with Twack and has an app-endpoint with ajax-output as well.
      I really look forward to hear, what you think of Twack🥳!
      Features Installation Usage Quickstart: Creating a component Naming conventions & component variants Component Parameters directory page parameters viewname Asset handling Services Named components Global components Ajax-Output Configuration Versioning License Changelog
    • By Robin S
      Page Reference Default Value
      Most ProcessWire core inputfield types that can be used with a Page Reference field support a "Default value" setting. This module extends support for default values to the following core inputfield types:
      Page List Select Page List Select Multiple Page Autocomplete (single and multiple) Seeing as these inputfield types only support the selection of pages a Page List Select / Page List Select Multiple is used for defining the default value instead of the Text / Textarea field used by the core for other inputfield types. This makes defining a default value a bit more user-friendly.
      Note that as per the core "Default value" setting, the Page Reference field must be set to "required" in order for the default value to be used.
      Screenshot

       
      https://github.com/Toutouwai/PageReferenceDefaultValue
      https://modules.processwire.com/modules/page-reference-default-value/
×
×
  • Create New...