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.

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

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   1 member

  • Similar Content

    • By robert
      I often had the need for an overview of all used fields and their contents for a specific page/template while developing new websites without switching to the backend, so I made a small module which lists all the needed information in a readable manner (at least for me):
      Debug Page Fields
      https://github.com/robertweiss/ProcessDebugPageFields
      It adds two new properties to all pages:
      $page->debugFieldValues – returns an object with all (sub-)fields, their labels, fieldtypes and values $page->debugFieldTypes – returns an object with all fieldtypes and their corresponding fields // List all values of a pages $page->debugFieldValues // List a specific field $page->debugFieldValues->fieldname // List all used fieldtypes of a page $page->debugFieldTypes I recommend using it in combination with Tracy Debugger, Ray, Xdebug etc. as it returns an object and is only meant for developing/debugging uses. 
      For now, the fieldtype support includes mostly fieldtypes I use in my projects, but can easily be extended by adding a new FieldtypeFIELDNAME method to the module. I use it with five different client installations (all PW 3.0.*), but of course there might be some (or more) field configurations which are not covered correctly yet.
      Supported fieldtypes
      Button Checkbox Color Combo Datetime Email FieldsetPage * File FontIconPicker Functional Image ImageReference MapMarker Multiplier Mystique Options Page PageIDs PageTitle Radio Repeater * RepeaterMatrix * RockAwesome SeoMaestro Table Text Textarea Textareas Toggle URL * The fields with complete subfield-support also list their corresponding subfields.
      Installation
      Download the zip file at Github or clone the repo into your site/modules directory. If you downloaded the zip file, extract it in your sites/modules directory. In your admin, go to Modules > Refresh, then Modules > New, then click on the Install button for this module. As this is my first ›public‹ module, I hope I did not miss any important things to mention here.
    • By horst
      Wire Mail SMTP

      An extension to the (new) WireMail base class that uses SMTP-transport

      This module integrates EmailMessage, SMTP and SASL php-libraries from Manuel Lemos into ProcessWire. I use this continously evolved libraries for about 10 years now and there was never a reason or occasion not to do so. I use it nearly every day in my office for automated composing and sending personalized messages with attachments, requests for Disposition Notifications, etc. Also I have used it for sending personalized Bulkmails many times.

      The WireMailSmtp module extends the new email-related WireMail base class introduced in ProcessWire 2.4.1 (while this writing, the dev-branch only).
       
      Here are Ryans announcement.



      Current Version 0.6.0
      Changelog: https://github.com/horst-n/WireMailSmtp/blob/master/CHANGELOG.md
      get it from the Modules Directory Install and Configure

      Download the module into your site/modules/ directory and install it.

      In the config page you fill in settings for the SMTP server and optionaly the (default) sender, like email address, name and signature.
      You can test the smtp settings directly there. If it says "SUCCESS! SMTP settings appear to work correctly." you are ready to start using it in templates, modules or bootstrap scripts.


      Usage Examples
      The simplest way to use it:
      $numSent = wireMail($to, $from, $subject, $textBody); $numSent = wireMail($to, '', $subject, $textBody); // or with a default sender emailaddress on config page This will send a plain text message to each recipient.
       
      You may also use the object oriented style:
      $mail = wireMail(); // calling an empty wireMail() returns a wireMail object $mail->to($toEmail, $toName); $mail->from = $yourEmailaddress; // if you don't have set a default sender in config // or if you want to override that $mail->subject($subject); $mail->body($textBody); $numSent = $mail->send(); Or chained, like everywhere in ProcessWire:
      $mail = wireMail(); $numSent = $mail->to($toEmail)->subject($subject)->body($textBody)->send(); Additionaly to the basics there are more options available with WireMailSmtp. The main difference compared to the WireMail BaseClass is the sendSingle option. With it you can set only one To-Recipient but additional CC-Recipients.
      $mail = wireMail(); $mail->sendSingle(true)->to($toEmail, $toName)->cc(array('person1@example.com', 'person2@example.com', 'person3@example.com')); $numSent = $mail->subject($subject)->body($textBody)->send(); The same as function call with options array:
      $options = array( 'sendSingle' => true, 'cc' => array('person1@example.com', 'person2@example.com', 'person3@example.com') ); $numSent = wireMail($to, '', $subject, $textBody, $options); There are methods to your disposal to check if you have the right WireMail-Class and if the SMTP-settings are working:
      $mail = wireMail(); if($mail->className != 'WireMailSmtp') { // Uups, wrong WireMail-Class: do something to inform the user and quit echo "<p>Couldn't get the right WireMail-Module (WireMailSmtp). found: {$mail->className}</p>"; return; } if(!$mail->testConnection()) { // Connection not working: echo "<p>Couldn't connect to the SMTP server. Please check the {$mail->className} modules config settings!</p>"; return; }  
      A MORE ADVANCED DEBUG METHOD!
      You can add some debug code into a template file and call a page with it:
      $to = array('me@example.com'); $subject = 'Wiremail-SMTP Test ' . date('H:i:s') . ' äöü ÄÖÜ ß'; $mail = wireMail(); if($mail->className != 'WireMailSmtp') { echo "<p>Couldn't get the right WireMail-Module (WireMailSmtp). found: {$mail->className}</p>"; } else { $mail->from = '--INSERT YOUR SENDER ADDRESS HERE --'; // <--- !!!! $mail->to($to); $mail->subject($subject); $mail->sendSingle(true); $mail->body("Titel\n\ntext text TEXT text text\n"); $mail->bodyHTML("<h1>Titel</h1><p>text text <strong>TEXT</strong> text text</p>"); $dump = $mail->debugSend(1); } So, in short, instead of using $mail->send(), use $mail->debugSend(1) to get output on a frontend testpage.
      The output is PRE formatted and contains the areas: SETTINGS, RESULT, ERRORS and a complete debuglog of the server connection, like this one:
       
      Following are a ...


      List of all options and features


      testConnection () - returns true on success, false on failures


      sendSingle ( true | false ) - default is false

      sendBulk ( true | false ) - default is false, Set this to true if you have lots of recipients (50+)


      to ($recipients) - one emailaddress or array with multiple emailaddresses

      cc ($recipients) - only available with mode sendSingle, one emailaddress or array with multiple emailaddresses

      bcc ($recipients) - one emailaddress or array with multiple emailaddresses

       
      from = 'person@example.com' - emailaddress, can be set in module config (called Sender Emailaddress) but it can be overwritten here

      fromName = 'Name Surname' - optional, can be set in module config (called Sender Name) but it can be overwritten here


      priority (3) - 1 = Highest | 2 = High | 3 = Normal | 4 = Low | 5 = Lowest

      dispositionNotification () or notification () - request a Disposition Notification


      subject ($subject) - subject of the message

      body ($textBody) - use this one alone to create and send plainText emailmessages

      bodyHTML ($htmlBody) - use this to create a Multipart Alternative Emailmessage (containing a HTML-Part and a Plaintext-Part as fallback)

      addSignature ( true | false ) - the default-behave is selectable in config screen, this can be overridden here
      (only available if a signature is defined in the config screen)

      attachment ($filename, $alternativeBasename = "") - add attachment file, optionally alternative basename


      send () - send the message(s) and return number of successful sent messages


      debugSend(1) - returns and / or outputs a (pre formatted) dump that contains the areas: SETTINGS, RESULT, ERRORS and a complete debuglog of the server connection. (See above the example code under ADVANCED DEBUG METHOD for further instructions!)


      getResult () - returns a dump (array) with all recipients (to, cc, bcc) and settings you have selected with the message, the message subject and body, and lists of successfull addresses and failed addresses,


      logActivity ($logmessage) - you may log success if you want

      logError ($logmessage) - you may log warnings, too. - Errors are logged automaticaly
       
       
      useSentLog (true | false) - intended for usage with e.g. third party newsletter modules - tells the send() method to make usage of the sentLog-methods - the following three sentLog methods are hookable, e.g. if you don't want log into files you may provide your own storage, or add additional functionality here

      sentLogReset ()  - starts a new LogSession - Best usage would be interactively once when setting up a new Newsletter

      sentLogGet ()  - is called automaticly within the send() method - returns an array containing all previously used emailaddresses

      sentLogAdd ($emailaddress)  - is called automaticly within the send() method
      Changelog: https://github.com/horst-n/WireMailSmtp/blob/master/CHANGELOG.md
       
       
    • By Cybermano
      Food Allergens Module
      A simple List of Food Allergens
      My needs were to provide a simple list of food allergens for our clients with restaurant related activity.
      The idea was to simply output the list (to speed up the data entry) without leaving the food menu editing, eg. opening another page in new tab or window.
      This isn't a perfect solution, but it works fine for my needs and I decided to share the base idea.
      This could also be easily used to show little notes or short "vademecum", not only for the list of food allergens.
      ---
      Main features
      The basis
      All moves from a short editing of the module in this tutorial: How to create custom admin pages by @bernhard
      First of all it creates an empty admin page, with a dedicated permission to let safe-user to see it (this permission has to be created as a new ones, manually or by the module).
      Once the page is created, I have hooked its behaviour into the ready.php, to show the content (basically a list).
      A step further
      With the tips of  @bernhard, @Soma (and many others), see here , the magic happens. 
      The new page will be shown as a panel, so editors will not abandon their data entry to have a quick view to the list.
      A little further
      Why scroll to the top of the page to click a link?
      The next step was to create a sticky button only in the food menu pages.
      Again with a @bernhard tip I moved into the customization of this simple module and the related hook.
      ---
      How to use this module
      After installed, it creates the page /admin/page/allergens/ and the module is to be setted up. The first field is a CKEditor with multi-language. This is the place where to write the informations that will be shown into the page. The next field is a simply text-area where to place a bit of JS that will be appended to the markup of the text (omit the 'script' tags). I also putted a checkbox with a silly statement: this to think at least twice on the safety of the written JS. Now comes the first way to display the link to the page
      Field Note with Link. Enable and save it. The module will display a new row with 4 selects (1 standard and 3 ASM):
      View mode (to show the page as Panel or as Modal PopUp); Templates to select: select one or more and save before proceed, so the  asm-select of the pages will be populated showing all the pages of the selected templates. Pages to select: also here select at least one and save before proceed to populate the asm-select for fields only with the ones that belong to the selected pages. Select the fields where to place the note and save again. That's all: now you will find into the notes of the selected fields the link "See the List of Allergens".
      At the same way, the option for the sticky button, but with a plus
      The field select is obviously unnecessary, but you could play with the last row: the inline styles to fix your sticky button where you like. Here you could set the sticky position of the <div> and the absolute ones of the <a>.

      Video Explanation
      In these screencasts you could see a custom JS that show a "copy" button near a "hanna-code" call.
      This because I've set a specific one for each allergen to show up a tooltip in the front end.

      Registrazione #33.mp4  

      Registrazione #34.mp4 ---
      Last but not the least
      Actually it works fine for my needs, even if it's much improvable: I'm working on the permissions creation, the uninstall section, a separate configs and defaults and how to include the hook into the module leaving free the ready.php. According to a simpler uninstall. Also I would make the link text as a dynamic text field, so it will be more flexible.
      I always learn a lot here, so I would share my code for whom it could be interested.
      I removed the hanna code references, but I provide you the html list of the allergens, English and Italian too, so you can paste them into the "source" of the CKEditor field to have a ready to use module.
      Obviously you are free to modify the code as per your needs.
      Please, keep in mind that I'm not a pro coder and I beg your pardon for my verbosity (speaking and coding). 😉
      I hope be helpful or for inspiration.
      Bye
      ready.phpList-ITA.htmlList-ENG.htmlAllergens.module
      README.md
    • By Robin S
      This module is sort of an upgrade to my earlier ImageToMarkdown module, and might be useful to anyone working with Markdown in ProcessWire.
      Copy Markdown
      Adds icons to images and files that allow you to copy a Markdown string to the clipboard. When you click the icon a message at the top left of the screen notifies you that the copying has occurred.
      Screencast

      Note: in the screencast an EasyMDE inputfield is used to preview the Markdown. It's not required to use EasyMDE - an ordinary textarea field could be used.
      Usage: Images
      When you hover on an item in an Images field an asterisk icon appears on the thumbnail. Click the icon to copy an image Markdown string to clipboard. If the "Description" field is populated it is used as the alt text.
      You can also open the "Variations" modal for an image and click the asterisk icon to copy an image Markdown string for an individual variation.
      Usage: Files
      When you hover on an item in a Files field an asterisk icon appears next to the filename. Click the icon to copy a link Markdown string to the clipboard. If the "Description" field is populated it is used as the link text, otherwise the filename is used.
       
      https://github.com/Toutouwai/CopyMarkdown
      https://processwire.com/modules/copy-markdown/
    • By BitPoet
      I've realized that I've been jumping back and forth between the PW API docs and the source code for site modules far too much. The idea to hold all necessary documentation locally in one place has occurred to me before, but getting PHPDocumentor et al set up and running reliably (and producing readable output) as always been too much of a hassle. Today I was asked how I find the right hooks and their arguments, and that inspired me to finally get my backside down on the chair and whip something up, namely the
      Module Api Doc Viewer
      ProcessModuleApiDoc
      It lets you browse the inline documentation and public (optionally also protected) class/method/property information for all modules, core classes and template files in the ProcessWire instance. The documentation is generated on the fly, so you don't have to remember to update your docs whenever you update a module.
      The module is quite fresh, so expect some bugs there. Behind the scenes it uses PHP-Parser together with a custom class that extracts the information I needed, and the core TextformatterMarkdownExtra module for rendering the description part in the phpdoc style comments.
      This is not a replacement / competitor to the API Viewer included in the commercial ProDevTools package. There is quite some information included in the inline documentation that my module can't (and won't) parse, but which makes up parts of the official ProcessWire API docs.
      This, instead, is a kind of Swiss army knife to view PHPDoc style information and get a quick class or function reference.
      If you feel daring and want to give it a spin, or if you just want to read a bit more, visit the module's GitHub repository.
      This is the overview page under "Setup" -> "Module API Docs":

      And this is what the documentation for an individual class looks like:

      The core module documentation can of course be found online, but it didn't make sense not to include them.
      Let me know what you think!

×
×
  • Create New...