Jump to content
adrian

Batch Child Editor

Recommended Posts

Thanks for the report @NorbertH!

There were a couple of updates this morning:

  1. fixing some issues with some page specific settings not overriding the main config settings
  2. added support for subfields in the field pairings - verified to work for Profields Textareas and MapMarker fields, but I think should work for most others as well - let me know if you find any that don't work.

A question for all you multi-language folks out there - does anyone ever rename the name of the title field? I am sure you often change the label, but the name is what I am concerned about. There are a few places in the module that check for "title" but I am thinking that if this is not always its name, then I might need to check for it by:

type = "FieldtypePageTitle"

Trouble is that it is possible to have more than one FieldtypePageTitle field on a site which seems a little weird - does anyone know a use case for that?

Any thoughts on this?

Share this post


Link to post
Share on other sites

$page->name

$page->id

and.....$page->title.....is international

I think "title" should not renamed for good practise reasons...so may a hint on the BCE documentation should be enough "If you rename the title field....it don't work".

But i'm not a pro so may more opinions are more helpfull.

Regards mr-fan

  • Like 1

Share this post


Link to post
Share on other sites

Ok, all new features have now been merged to the master branch. I have changed the release state from Stable to Beta for this release. Really just as a precaution for the Update mode options until I have had more feedback on this.

Please let me know how this new version works out for everyone. It will probably take you a while to go through all the new configuration options, but I think it's worth the effort. You can use this module as a simple replacement for the Children/Subpages section of the Children tab (which allows for much quicker editing of child pages), all the way through to a fully customizable CSV import tool for site site editors to create and update pages.

Feel free to send through any other ideas along with any issues you come across.

  • Like 4

Share this post


Link to post
Share on other sites

Thank you adrian for your great work on this module.

It's a full blown batch child editor suite for flexible CSV Imports - in as a minimum reward for your work i did the complete german translation, to get more users involved on this module and it's advantages.

Kind regards mr-fan

1. did a PR on some strings that lost via c&p the settingsstrings at the end of the module

https://github.com/adrianbj/BatchChildEditor/pull/3

2. only one problem with two strings that i can't figure out since i see no difference between the working one and the two others...screenshot added

post-2327-0-90072900-1431348635_thumb.pn

3. languagfile as zip attached

deutsch-batcheditor.zip

  • Like 2

Share this post


Link to post
Share on other sites

Thanks for the kind words and for your efforts on this translation - must have been quite a task - there's lots to translate in this module :)

I accepted your PR and also fixed (I think) the issue you were having translating that the enabled templates setting description. Please let me know if it works now.

  • Like 1

Share this post


Link to post
Share on other sites
I accepted your PR and also fixed (I think) the issue you were having translating that the enabled templates setting description. Please let me know if it works now.

just tested this. I can reproduce the non-translated text. It's because you use double-quotes instead of single quotes? Example: line 1005, 1021

Please search for \nNB inside the file. Normally you only need \n for a new line. Or has this (NB) a special meaning? Next problem: with single quotes only \n didn't work.

Share this post


Link to post
Share on other sites

Thanks @Manfre62 for testing.

I don't think the double quotes is the issue because in @mr-fan's screenshot he has translated the "Configurable Pages" option and the description for it also uses double quotes. I don't use translated modules though, so could you please double check and confirm that it is the double-quotes.

It's always been my experience that you can't use \n inside single quotes, which is why I use them in situations where I want to break things across more than one line.

"NB" is a common acronym in English for Nota bene which is latin for "Note well".

Share this post


Link to post
Share on other sites

tried it again. When using single qoutes, text is translated. But new line doesn't work. There are 3 sections (screenshot):

post-1027-0-98093800-1431371813_thumb.jp

BTW: didn't know/used NB :huh: Thanks for info

Share this post


Link to post
Share on other sites

Thanks for testing. I'd probably be OK without the line breaks in those spots in your screenshot, but what about this line for example: 

https://github.com/adrianbj/BatchChildEditor/blob/master/BatchChildEditor.module#L1198 - this definitely needs the line breaks.

It seems like this should work. Could you please confirm?

$fieldEnabledTemplates->description = __('The batch editing option will only be available for the selected templates.'."\n".'NB Leave blank to allow all templates.', __FILE__);

I probably should switch them all over to: $this->_() for the speed advantage since they are all inside a class, but that can wait for now.

  • Like 1

Share this post


Link to post
Share on other sites
It seems like this should work. Could you please confirm?
$fieldEnabledTemplates->description = __('The batch editing option will only be available for the selected templates.'."\n".'NB Leave blank to allow all templates.', __FILE__);

the concatenation doesn't work.

Share this post


Link to post
Share on other sites

OK, I think they need to be treated as separate translatable strings, like this:

$fieldEnabledTemplates->description = __('The batch editing option will only be available for the selected templates . '. "\n" . __('NB Leave blank to allow all templates.', __FILE__);

Or using $this->_() it would look like:

$fieldEnabledTemplates->description = $this->_('The batch editing option will only be available for the selected templates . '. "\n" . $this->_('NB Leave blank to allow all templates.', __FILE__);

Seems a shame to have multiple strings to translate though just because there is a line break, but as far as I can tell there is no other way. Or maybe it actually makes more sense so the translator can't accidentally remove the line break?

  • Like 1

Share this post


Link to post
Share on other sites

Another major new feature!

I have added an Export to CSV mode which generates a CSV file containing the fields for all child pages.

It currently supports most field types, including:

  • Text/Textarea/Integer/Date fields
  • Page fields - exports the "Title" if available, or "Name" if not (eg user template), rather than just the page ID
  • File/Images - exports the filenames
  • Profields Textareas - automatically converts field into multiple columns - one for each subfield
  • Profields Multiplier - separates values with a customizable separator - you can choose a line break if you want which is nice when opening the CSV in Excel. This same customizable separator is available for other multiple fields like Page fields, File/Image etc

It does not support Profields Table, PageTable or Repeaters as these would get very messy. Note if you want to provide an export for specific Table fields, don't forget to check out: Table CSV Import/Export 

Fields to be exported can be predefined or customized by the user.

post-985-0-40876500-1432668435_thumb.png

Also includes an API export method:

//export as CSV if csv_export=1 is in url
if($input->get->csv_export==1){
   $modules->get('ProcessChildrenCsvExport'); //load helper module

   //delimiter, enclosure, file extension, names in first row, multiple field separator, array of field names
   $page->exportCsv(',', '"', 'csv', true, "\r", array('title','images','textarea_test'));
   //$page->exportCsv() - this version uses the defaults from the module or page specific settings
}
// display content of template with link to same page with appended csv_export=1
else{
   include("./head.inc");
   echo "<a href='./?csv_export=1'>Export Table as CSV</a>"; //link to initiate export
   include("./foot.inc");
}

Like the rest of this module, everything is configurable at various levels, so you can include this functionality as a separate tab, or part of the Children tab. You can predefine all settings so the user only has a simple Export button - whatever works best for you.

Please let me know how this new functionality works out for you and if you have any suggestions for improvements.

  • Like 9

Share this post


Link to post
Share on other sites

Sorry for all the quick updates, but am using this to populate a huge site and finding new needs so implementing as I go.

You can now change the template of each child page in the Edit mode. Because this change happens without warnings, it is controlled by the new "Allow template changes" setting in the module config. Of course the ability to change templates is also additionally controlled by the user's "page-template" permission.

Note - you might potentially only want to enable "Allow template changes" while your site is in development and disable once it is live to avoid any disasters.

post-985-0-36110900-1432737778_thumb.png

TIP: If you want to change the template for all child pages at once and there are lots of pages, this could still be a little tedious. So instead, use the "Replace" mode, choose the "Child Template" at the top and click Save. This will delete and recreate all child pages with the selected template. This is super fast if the pages don't have any content yet (or child pages of their own), which can often be the case early in development when you are still figuring out which pages will have which templates!

  • Like 5

Share this post


Link to post
Share on other sites

This is becoming more and more impressive and useful with each update! Great stuff. On of my most used modules.

  • Like 4

Share this post


Link to post
Share on other sites

Thanks SiNNuT - I really appreciate you letting me know that you're finding it so useful.!

I hope you'll also like the next little enhancement :)

Edit mode now has hidden and unpublished checkboxes:

post-985-0-34834300-1432782725_thumb.png

  • Like 5

Share this post


Link to post
Share on other sites

This is getting really really great tool for editing, import and now export, too....tell me when you "run slower" forward...that i could translate the missing things to german as well.

Best regards mr-fan

  • Like 2

Share this post


Link to post
Share on other sites

Great module! :)

Exporting to CSV works well for small to medium numbers of child pages, but is failing silently for large numbers of child pages. In my case, around 3000 children, with 20 fields per page. I'm probably asking a bit much to try and export such a large volume of data. Maybe large exports like this could be done in batches somehow?

Share this post


Link to post
Share on other sites

More informations about errors, php environment...(memory, execution time....) ?

No problems here with "big data" tested with 3000+ and about 15 fields per page.

regards mr-fan

  • Like 1

Share this post


Link to post
Share on other sites

More informations about errors, php environment...(memory, execution time....) ?

After clicking the "Export as CSV" button the browser "loads" for about four seconds then stops loading.

No errors displayed in browser, no errors in ProcessWire error log, and no error logs in the module folder.

Basic shared hosting, PHP 5.4, memory_limit: 64M, max_execution_time: 30.

Exporting the same data via Ryan's CSV export addon for Lister Pro works fine (which solves my CSV export needs).

Share this post


Link to post
Share on other sites

Cerulean - sorry for the delay, I was on vacation. Like mr-fan, I haven't had issues either with this, but I do have my memory settings quite high. I should probably add some batch functionality to the exporting like the ListerPro action uses. I'll add it to my list of things to do, hopefully fairly shortly.

Share this post


Link to post
Share on other sites

I would be nice if the "Edit Children Editor" would honor template family settings.

Sorry I thought it was already doing this correctly, but I just checked and noticed that setting "Can this template be used for new pages?" to "No" doesn't remove the "Add New" button - is that the issue you are referring to? 

I am using addable() on the parent page for determining if the Add New button should be displayed, but I see that this has an override for superusers. It also doesn't consider the noParents setting - you need the createable() method for that. 

Is this the issue you are having? Are you testing as superuser? Is the behavior correct as normal user?

I am in a rush out the door, so will look at this further when I am back, but I might need to use a different approach for checking this.

Share this post


Link to post
Share on other sites

It's not exactly what I was taking about. I used the Child editor to edit some existing pages and add a few new ones. The parent page to those would only allow for a single template for children, but the template select boxes did show me all templates.

Share this post


Link to post
Share on other sites

It's not exactly what I was taking about. I used the Child editor to edit some existing pages and add a few new ones. The parent page to those would only allow for a single template for children, but the template select boxes did show me all templates.

Sorry - I can't seem to duplicate this at all here - for me there is only the one template option listed. Is there any way you can narrow things down to a certain configuration? Perhaps access to a test install that is showing the issue?

Thanks for helping to figure this out.

Share this post


Link to post
Share on other sites

@LostKobrakai - I just pushed a new version that adds a lot of new allowed template checking logic - can you please see if this fixes the issues you were having?

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 BitPoet
      Here's a little text formatter module that redirects all external links found in a textarea (e.g. for hit counting) to a given URL.
      TextformatterExternalRedirect
      GitHub repo
      As TextFormatters do, this module modifies the contents of the textarea (HTML) at rendering time. It prepends the given URL to the link address for external links (http and https), optionally makes sure that the link is opened in a new window and allows you to add css classes to such links.
      All options can be configured in the module's configuration settings.
      Usage:
      Download the zip archive and extract it to site/modules, the rename the top folder to TextformatterExternalRedirect Go to the backend and select "Modules" -> "Refresh", then click "Install" for "External Link Redirect" Click "Settings" and configure the module
      Go into the field configuration for the field(s) you want this formatter to apply to and add it from the dropdown
      Done, now any external links in the configured fields will have the configured settings applied Feel free to leave feedback and post and questions you have here.
       
    • By teppo
      Hey folks!
      Took a couple of late nights, but managed to turn this old gist of mine into a proper module. The name is SearchEngine, and currently it provides support for indexing page contents (into a hidden textarea field created automatically), and also includes a helper feature ("Finder") for querying said contents. No fancy features like stemming here yet, but something along those lines might be added later if it seems useful (and if I find a decent implementation to integrate).
      Though the API and selector engine make it really easy to create site search pages, I pretty much always end up duplicating the same features from site to site. Also – since it takes a bit of extra time – it's tempting to skip over some accessibility related things, and leave features like text highlighting out. Overall I think it makes sense to bundle all that into a module, which can then be reused over and over again 🙂
      Note: markup generation is not yet built into the module, which is why the examples below use PageArray::render() method to produce a simple list of results. This will be added later on, as a part of the same module or a separate Markup module. There's also no fancy JS API or anything like that (yet).
      This is an early release, so be kind – I got the find feature working last night (or perhaps this morning), and some final tweaks and updates were made just an hour ago 😅
      GitHub repository: https://github.com/teppokoivula/SearchEngine Modules directory: https://modules.processwire.com/modules/search-engine/ Demo: https://wireframe-framework.com/search/ Usage
      Install SearchEngine module. Note: the module will automatically create an index field install time, so be sure to define a custom field (via site config) before installation if you don't want it to be called "search_index". You can change the field name later as well, but you'll have to update the "index_field" option in site config or module settings (in Admin) after renaming it.
      Add the site search index field to templates you want to make searchable. Use selectors to query values in site search index. Note: you can use any operator for your selectors, you will likely find the '=' and '%=' operators most useful here. You can read more about selector operators from ProcessWire's documentation.
      Options
      By default the module will create a search index field called 'search_index' and store values from Page fields title, headline, summary, and body to said index field when a page is saved. You can modify this behaviour (field name and/or indexed page fields) either via the Module config screen in the PocessWire Admin, or by defining $config->SearchEngine array in your site config file or other applicable location:
      $config->SearchEngine = [ 'index_field' => 'search_index', 'indexed_fields' => [ 'title', 'headline', 'summary', 'body', ], 'prefixes' => [ 'link' => 'link:', ], 'find_args' => [ 'limit' => 25, 'sort' => 'sort', 'operator' => '%=', 'query_param' => null, 'selector_extra' => '', ], ]; You can access the search index field just like any other ProcessWire field with selectors:
      if ($q = $sanitizer->selectorValue($input->get->q)) { $results = $pages->find('search_index%=' . $query_string . ', limit=25'); echo $results->render(); echo $results->renderPager(); } Alternatively you can delegate the find operation to the SearchEngine module as well:
      $query = $modules->get('SearchEngine')->find($input->get->q); echo $query->resultsString; // alias for $query->results->render() echo $query->pager; // alias for $query->results->renderPager() Requirements
      ProcessWire >= 3.0.112 PHP >= 7.1.0 Note: later versions of the module may require Composer, or alternatively some additional features may require installing via Composer. This is still under consideration – so far there's nothing here that would really depend on it, but advanced features like stemming most likely would.
      Installing
      It's the usual thing: download or clone the SearchEngine directory into your /site/modules/ directory and install via Admin. Alternatively you can install SearchEngine with Composer by executing composer require teppokoivula/search-engine in your site directory.
    • By teppo
      MarkupMenu is a markup module for generating menu trees. When provided a root page as a starting point, it generates a navigation tree (by default as a HTML "<ul>" element wrapped by a "<nav>" element) from that point onwards. If you've also provided it with current (active) page, the menu will be rendered accordingly, with current item highlighted and items rendered up to that item and its children (unless you disable the "collapsed" option, in which case the full page tree will be rendered instead).
      Modules directory: https://modules.processwire.com/modules/markup-menu/ GitHub repository: https://github.com/teppokoivula/MarkupMenu Usage
      As a markup module, MarkupMenu is intended for front-end use, but you can of course use it in a module as well. Typically you'll only need the render() method, which takes an array of options as its only argument:
      echo $modules->get('MarkupMenu')->render([ 'root_page' => $pages->get(1), 'current_page' => $page, ]); Note: if you omit root_page, site root page is used by default. If you omit current_page, the menu will be rendered, but current (active) page won't be highlighted etc.
      A slightly more complex example, based on what I'm using on one of my own sites to render a (single-level) top menu:
      echo $modules->get('MarkupMenu')->render([ 'current_page' => $page, 'templates' => [ 'nav' => '<nav class="{classes} menu--{menu_class_modifier}" aria-label="{aria_label}">%s</nav>', 'item_current' => '<a class="menu__item menu__item--current" href="{item.url}" tabindex="0" aria-label="Current page: {item.title}">{item.title}</a>', ], 'placeholders' => [ 'menu_class_modifier' => 'top', 'aria_label' => 'Main navigation', ], 'include' => [ 'root_page' => true, ], 'exclude' => [ 'level_greater_than' => 1, ], ]); Note: some things you see above may not be entirely sensible, such as the use of {menu_class_modifier} and {aria_label} placeholders. On the actual site the "nav" template is defined in site config, so I can define just these parts on a case-by-case basis while actual nav markup is maintained in one place.
      Please check out the README file for available render options. I'd very much prefer not to keep this list up to date in multiple places. Basically there are settings for defining "templates" for different parts of the menu (list, item, etc.), include array for defining rules for including in the menu and exclude array for the opposite effect, classes and placeholders arrays for overriding default classes and injecting custom placeholders, etc. 🙂
      MarkupMenu vs. MarkupSimpleNavigation
      TL;DR: this is another take on the same concept. There are many similarities, but also some differences – especially when it comes to the supported options and syntax. If you're currently using MarkupSimpleNavigation then there's probably no reason to switch over.
      I'd be surprised if someone didn't draw lines between this module and Soma's awesome MarkupSimpleNavigation. Simply put I've been using MSN (...) for years, and it's been great – but there are some issues with it, particularly in the markup generation area, and it also does some things in a way that doesn't quite work for me – the xtemplates thing being one of these. In some ways less about features, and more about style, I guess 🙂
      Anyhow, in MarkupMenu I've tried to correct those little hiccups, modernise the default markup, and allow for more flexibility with placeholder variables and additional / different options. MarkupMenu was built for ProcessWire 3.0.112+ and with PHP 7.1+ in mind, it's installable with Composer, and I have a few additional ideas (such as conditional placeholders) still on my todo list.
      One more small(ish) difference is that MarkupMenu supports overriding default options via $config->MarkupMenu. I find myself redefining the default markup for every site, which until now meant that each site had a wrapper function for MarkupSimpleNavigation (to avoid code / config repetition), and this way I've been able to leave that out 🙂
      Requirements
      ProcessWire >= 3.0.112 PHP >= 7.1.0 If you're working on an earlier version of ProcessWire or PHP, use MarkupSimpleNavigation instead.
    • By teppo
      Hey folks!
      I'm happy to finally introduce a project I've been working on for quite a while now: it's called Wireframe, and it is an output framework for ProcessWire.
      Note that I'm posting this in the module development area, maily because this project is still in rather early stage. I've built a couple of sites with it myself, and parts of the codebase have been powering some pretty big and complex sites for many years now, but this should still be considered a soft launch 🙂
      --
      Long story short, Wireframe is a module that provides the "backbone" for building sites (and apps) with ProcessWire using an MVC (or perhaps MVVM – one of those three or four letter abbreviations anyway) inspired methodology. You could say that it's an output strategy, but I prefer the term "output framework" since in my mind the word "strategy" means something less tangible. A way of doing things, rather than a tool that actually does things.
      Wireframe (the module) provides a basic implementation for some familiar MVC concepts, such as Controllers and a View layer – the latter of which consists of layouts, partials, and template-specific views. There's no "model" layer, since in this context ProcessWire is the model. As a module Wireframe is actually quite simple – not even nearly the biggest one I've built – but there's still quite a bit of stuff to "get", so I've put together a demo & documentation site for it at https://wireframe-framework.com/.
      In addition to the core module, I'm also working on a couple of site profiles based on it. My current idea is actually to keep the module very light-weight, and implement most of the "opinionated" stuff in site profiles and/or companion modules. For an example MarkupMenu (which I released a while ago) was developed as one of those "companion modules" when I needed a menu module to use on the site profiles.
      Currently there are two public site profiles based on Wireframe:
      site-wireframe-docs is the demo&docs site mentioned above, just with placeholder content replaced with placeholder content. It's not a particularly complex site, but I believe it's still a pretty nice way to dig into the Wireframe module. site-wireframe-boilerplate is a boilerplate (or starter) site profile based on the docs site. This is still very much a work in progress, but essentially I'm trying to build a flexible yet full-featured starter profile you can just grab and start building upon. There will be a proper build process for resources, it will include most of the basic features one tends to need from site to site, etc. --
      Requirements and getting started:
      Wireframe can be installed just like any ProcessWire module. Just clone or download it to your site/modules/ directory and install. It doesn't, though, do a whole lot of stuff on itself – please check out the documentation site for a step-by-step guide on setting up the directory structure, adding the "bootstrap file", etc. You may find it easier to install one of the site profiles mentioned above, but note that this process involves the use of Composer. In the case of the site profiles you can install ProcessWire as usual and download or clone the site profile directory into your setup, but after that you should run "composer install" to get all the dependencies – including the Wireframe module – in place. Hard requirements for Wireframe are ProcessWire 3.0.112 and PHP 7.1+. The codebase is authored with current PHP versions in mind, and while running it on 7.0 may be possible, anything below that definitely won't work. A feature I added just today to the Wireframe module is that in case ProcessWire has write access to your site/templates/ directory, you can use the module settings screen to create the expected directories automatically. Currently that's all, and the module won't – for an example – create Controllers or layouts for you, so you should check out the site profiles for examples on these. (I'm probably going to include some additional helper features in the near future.)
      --
      This project is loosely based on an earlier project called pw-mvc, i.e. the main concepts (such as Controllers and the View layer) are very similar. That being said, Wireframe is a major upgrade in terms of both functionality and architecture: namespaces and autoloader support are now baked in, the codebase requires PHP 7, Controllers are classes extending \Wireframe\Controller (instead of regular "flat" PHP files), implementation based on a module instead of a collection of drop-in files, etc.
      While Wireframe is indeed still in a relatively early stage (0.3.0 was launched today, in case version numbers matter) for the most part I'm happy with the way it works, and likely won't change it too drastically anytime soon – so feel free to give it a try, and if you do, please let me know how it went. I will continue building upon this project, and I am also constantly working on various side projects, such as the site profiles and a few unannounced helper modules.
      I should probably add that while Wireframe is not hard to use, it is more geared towards those interested in "software development" type methodology. With future updates to the module, the site profiles, and the docs I hope to lower the learning curve, but certain level of "developer focus" will remain. Although of course the optimal outcome would be if I could use this project to lure more folks towards that end of the spectrum... 🙂
      --
      Please let me know what you think – and thanks in advance!
    • By Robin S
      After forgetting the class name of the wonderful AdminPageFieldEditLinks module for what feels like the 100th time I decided I needed to give my failing memory a helping hand...
      Autocomplete Module Class Name
      Provides class name autocomplete suggestions for the "Add Module From Directory" and "Add Module From URL" fields at Modules > New.
      Requires ProcessWire >= v3.0.16.
      Screencast

      Installation
      Install the Autocomplete Module Class Name module.
      Configuration
      Add Module From Directory
      Choose the type of autocomplete suggestions list: "Module class names from directory" or "Custom list of module class names". The latter could be useful if you regularly install some modules and would prefer a shorter list of autocomplete suggestions. The list of class names in the modules directory is generated when the Autocomplete Module Class Name module is installed. It doesn't update automatically (because the retrieval of the class names is quite slow), but you can use the button underneath when you want to retrieve an updated list of class names from the directory. Add Module From URL
      If you want to see autocomplete suggestions for the "Add Module From URL" field then enter them in the following format:
      [autocomplete suggestion] > [module ZIP url]
      Example: RepeaterImages > https://github.com/Toutouwai/RepeaterImages/archive/master.zip Awesomplete options
      The "fuzzy search" option uses custom filter and item functions for Awesomplete so that the characters you type just have to exist in the autocomplete suggestion item and occur after preceding matches but do not need to be contiguous. Uncheck this option if you prefer the standard Awesomplete matching. Custom settings for Awesomplete can be entered in the "Awesomplete options" field if needed. See the Awesomplete documentation for more information.  
      https://github.com/Toutouwai/AutocompleteModuleClassName
      https://modules.processwire.com/modules/autocomplete-module-class-name/
×
×
  • Create New...