Jump to content
Mats

Module: Leaflet Map

Recommended Posts

I have encountered a bug: as soon as I turn on the cache function (Processwire built-in) the maps don't load any more on Chrome. Firefox works, though. Any idea what causes this?

Share this post


Link to post
Share on other sites
On 10/6/2019 at 6:07 PM, sujag said:

I'm trying to automatically add pages containing a field with this fieldtype. while all other fields are populated as expected the lat/lng part of my geolocation field keeps its default values. Is there a special syntax to address these

I don't really understand why, but it works, if I change lat lng values in a second step.

$newPoi = $pages->add("tmbPoi", "$parentPage->url", [
                    'name' => $thisPoiId,
                    'title' => $poi['name'],
					...
					]

$newPoi->geolocation->lat = $lat;
$newPoi->geolocation->lng = $lng;
$newPoi->of(false);
$newPoi->save('geolocation');

 

Share this post


Link to post
Share on other sites

Hi @All,

When I turn on cache, the map is blank. What variable should I exclude or...!?

Share this post


Link to post
Share on other sites

This is a really nice module, but why is the fully working version only in the 'dev' release?

EDIT: Having said that, I now find I have the same problem as the previous poster. It all works fine on my Dev machine. But in the live environment it is blank.

EDIT 2: In my case, the problem was simple - just forgot to upload the additional lines in the <head> - i.e.

    <?php $map = wire('modules')->get('MarkupLeafletMap'); ?>
    <?php echo $map->getLeafletMapHeaderLines(); ?>

Is that your problem @Leftfield?

  • Like 1

Share this post


Link to post
Share on other sites

@MarkE thank you for your answer but it doesn't help since I load files manually (except main js). Anyway, I will remove module for two reasons (both not fault of the module):
First: Lon and Lat are not compatible with Google Maps for my country. There is some wild offset.
Second: Will test for SEO, doubt is that Google doesn't rank website with Open street map.

Share this post


Link to post
Share on other sites

i installed the module, but i'm not able to get it working, i get the error "Error geocoding address" in the backend and a blank map ?

What is missing/wrong ?

Share this post


Link to post
Share on other sites
On 11/24/2019 at 6:40 PM, ank said:

i installed the module, but i'm not able to get it working, i get the error "Error geocoding address" in the backend and a blank map ?

What is missing/wrong ?

I have the same issue. Installed it as per the guidelines, but it throwing me the same issue. 

Share this post


Link to post
Share on other sites

i added the coordinates manually and now i get the map

but Is it possible to change the colors of the map

Share this post


Link to post
Share on other sites
18 hours ago, DL7 said:

I have the same issue. Installed it as per the guidelines, but it throwing me the same issue. 

So using the dev version, the geo coding is working. (also when you add a key to the google geo call). But I now run into an issue where the map is grey out in the "edit page" set-up. I cant fill in an address either as the input field is disabled. @hellomoto mentioned this issue before. Did you got a chance to fix it? @Mats ay pointers?

Share this post


Link to post
Share on other sites

So, somehow I got it fixed, by changing  the Default Map Tile Provider in the field setting. Somehow the default OpenStreetMap.Mapnik doesnt work for me. 

Share this post


Link to post
Share on other sites

Hello,

After spending hours trying to find a solution, I ask the community for help... I have a map showing up on page load. It works fine but it takes quite a while. You can see it in action there : https://planetalert.tuxfamily.org/world/6ef (be patient, loading is terrible)

I have already tried caching parts of my page (the different lists) and it's ok, but I can't manage to cache the map. So I would like to load the 2nd tab (when clicking on the faces icon at the top-left corner) by default to get a fast loading page and have my map loading on an ajax call. But all my tests are complete failures 😞

Here's my ajax part of code :

	[...] // Setting $allElements (for markers) and $options there
	$map = $modules->get('MarkupLeafletMap');
$out .= $map->getLeafletMapHeaderLines();
$out .= $map->render($allElements, 'map', $options);
	

Eventually, I get my map box, but it stays empty 😞 

Any advice, please ?

Share this post


Link to post
Share on other sites

@celfred: This has nothing to do with the map itself. It takes 15 seconds four your server to generate a response, after that the map and all of its content loads fast. So I assume your process of building the list of markers is somewhat ineffective. Can you show the code with which you generate the $allElements Array?

 

Share this post


Link to post
Share on other sites
On 1/22/2020 at 4:49 PM, MadeMyDay said:

@celfred: This has nothing to do with the map itself. It takes 15 seconds four your server to generate a response, after that the map and all of its content loads fast. So I assume your process of building the list of markers is somewhat ineffective. Can you show the code with which you generate the $allElements Array?

 

@MadeMyDay Thanks for your reply. From your comment, I have tried testing my $allEments function (it takes 0.415s on localhost). You can see the code there : https://framagit.org/celfred/planetAlert/blob/master/site/templates/my-functions.inc (function teamFreeWorld() line 1468) BUT I have also tried this :

	$out .= $map->render($allElements->eq(0), 'map', $options);

And the page now loads a lot faster (I can tell the difference even on localhost) ! So maybe it's because I have 56 (or even 96) markers, with a photo... ? What could I do, then ?

I hope you (or anybody else) will have other pieces of advice for me 🙂 My site has improved so much over the years thansk to the help of this community (and I have learned so much - you can tell I'm not a pro dev 😉 - I'm a teacher and the website is for motivating my middle-school pupils)

EDIT : Well, for the moment, I've just removed the images in my map markers tooltips and it loads faster... 

Share this post


Link to post
Share on other sites

Hi, I have problems with this module, the module show the map in the admin page but not show the map in the front page, the module work fine in my localhost. This is the online page where it doesn't work:

https://educakids.edu.co/contacto/

 

Share this post


Link to post
Share on other sites

Hi! 

Did you install the MarkupAddInlineScript module? 

/Mats

Share this post


Link to post
Share on other sites
51 minutes ago, Mats said:

Hi! 

Did you install the MarkupAddInlineScript module? 

/Mats

Hi @Mats the module is installed,

Share this post


Link to post
Share on other sites

I have this module implemented on a website and all works well. It currently outputs popups as per the attached image – the first line is generated by the module/options but I can't seem to override it in any way. The map pull sin information from it's child pages, and the title in the pop up links to the child page, but I want to change this so it links to the company's website instead (as per the url further down the pop-up). I've tried changing the 'markerLinkField' / 'markerTitleField' options, leaving them blank, etc but that either displays as per the attached or stops the pop up working.

Any thoughts much appreciated.

Screenshot 2020-08-03 at 15.15.02.png

Share this post


Link to post
Share on other sites

Issue 1:

Why do I get lots of random Russian (?) text when I try to look up addresses? And the location search results are awful; the system suggests random street addresses (with lots of Russian) when you type in something basic like 'London, England'. Full addresses seem to work better, but only without postal codes - 'nothing found' when you try to search with postal codes included.

Issue 2:

Maps show up in the admin area, but not on the front-end. I have another version of the same site where they do show up on the front-end without problems, so am a bit puzzled where the problem could be. What are typical causes I could check?

Edit:

The problem with the map not showing up on the front end (Issue 2) had something to do with this error showing up in Chrome Inspect/DevTools:

Uncaught TypeError: $ is not a function at (index):529

Something with jQuery. The error disappeared when I copied module files from another site where Leaflet Map did work. Not sure where the cause of the error is exactly.

 

Share this post


Link to post
Share on other sites
Uncaught TypeError: $ is not a function at (index):529

I have the same issue with a new install.

In dev tools everything is rendered, just no map at all.

 

Share this post


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

Uncaught TypeError: $ is not a function at (index):529

I have the same issue with a new install.

In dev tools everything is rendered, just no map at all.

 

Check that you are loading jQuery in the frontend.

  • Like 1

Share this post


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

Check that you are loading jQuery in the frontend.

Your right. I did not notice it was not loaded. Thanks @Beluga

Share this post


Link to post
Share on other sites

Hello,

is it possible to render the input field on a frontend template (for loggedin users only).

I tried this:

<?php 
$m = $modules->get('InputfieldLeafletMapMarker');
$m->render();
?>

This generates errors for empty variables.

PHP Notice: Trying to get property 'lat' of non-object in ...\InputfieldLeafletMapMarker.module:102
PHP Warning: Creating default object from empty value in ...\InputfieldLeafletMapMarker.module:102
PHP Notice: Undefined property: stdClass::$lng in ...\InputfieldLeafletMapMarker.module:103
PHP Notice: Undefined property: stdClass::$zoom in ...\InputfieldLeafletMapMarker.module:104
PHP Notice: Undefined property: stdClass::$address in ...\InputfieldLeafletMapMarker.module:105
PHP Notice: Undefined property: stdClass::$status in ...\InputfieldLeafletMapMarker.module:106
PHP Notice: Undefined property: stdClass::$status in ...\InputfieldLeafletMapMarker.module:107
PHP Notice: Undefined property: stdClass::$raw in ...\InputfieldLeafletMapMarker.module:130

Share this post


Link to post
Share on other sites

Hi there,

thanks for providing the Leaflet Map Marker module - very useful!

One thing I couldn't figure though is: how can I set NO default address to a field? I need to have the map as an optional field for a given template.

Thanks for any advice.

jor

Share this post


Link to post
Share on other sites

@jor

Not sure if this is the correct way, but on my map template I wrap my code with:

if($page->marker->address) {

}

e.g.

if($page->marker->address) {

	$map = wire('modules')->get('MarkupLeafletMap'); 
	$options = array(

    'markerFormatter' => function($page, $marker_options) {
        			if ($page->marker_icon->title) {
                        $marker_options['icon'] = $page->marker_icon->title;
                    }

                    if ($page->marker_colour->title) {
                        $marker_options['markerColor'] = $page->marker_colour->title;
                    }

                    // And the icon colour. This is another text field. Colour values like White, Black or an RGB value are ok here.
                    if ($page->marker_icon_colour->title) {
                        $marker_options['iconColor'] = $page->marker_icon_colour->title;
                    }    
        return $marker_options;
    },

    'popupFormatter' => function($page) {
        $out[] = "<strong>$page->headline</strong>";
        return implode('<br/>', $out);
    }

);
       

$content.= $map->render($page, 'marker', $options);

}

If no address is entered, no map is shown.

Share this post


Link to post
Share on other sites

Hey there,

I don't know if this might help smeone (and if I did it the right way), but I had an issue as follow : all maps worked on my site except 2 monuments which didn't show any map. I noticed they had a single quote in their name and if I got rid of it the map appeared.

I then ended up doing this (in my '$opitions' array) and it worked :

	'popupFormatter' => function($page) {
 $page->title = str_replace('\'', '\\\'', $page->title); // Dirty hack (no map if single quote in title)
 $out[] = '<strong>'.sprintf(__('In %1$s, in %2$s'), $page->city->title, $page->country->title).'</strong>';
 $out[] = "<p class=\"text-center\"><img src=\"{$page->photo->eq(0)->getCrop('thumbnail')->url}\" /></p>"; // ** NB: Use escaped double quotes if HTML attributes needed **
 return implode('<br/>', $out);
},
	

Again, it might sound a bit hacky, but it works for me and maybe it can be useful to someone...

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