Jump to content
horst

CroppableImage

Recommended Posts

 

--------------------------------------------------------------------------------------------------------------------------------

                             for PW 3.0+ please follow this link!

--------------------------------------------------------------------------------------------------------------------------------

Croppable Image

Module for PW >= 2.5.11 and PW <= 2.7.3

Version 0.8.3 alpha


Hey, today I can announce an early (alpha) release of CroppableImage, what was forked from Anttis Thumbnails module.

Until now there was a lot of work done by owzim, Martijn Geerts and me.

We have solved the issues regarding the list from here:

  • The modules are bundled together so that you only can and have to use FieldtypeCroppableImage for install, uninstall & configure.
     
  • It uses new naming scheme that was introduced with PW 2.5.0 that supports suffixes.
     
  • The complete image rendering is delegated to the core ImageSizer, or to any optional hooked in rendering engine.
     
  • Template-settings are now fully supported, including removing variations when settings have changed.
     
  • It fully respects settings for upscaling. If upscaling is set to false, you cannot select rectangles smaller than the crop setting.
     

We implemented these enhancements:

  • The GridView now is very nice and compact, and also benefits from the lately introduced setting for $config->adminThumbOptions.
     
  • Permanent storage of the crop coordinates, quality and sharpening settings are now implemented native. No need to use PiM for this anymore.
     
  • The usage/display of the Quality and Sharpening DropDown-Selects can be globally disabled/allowed in the modules Configpage. (additionally to that a setting on a 'per field base' is planned.)

And the most wanted feature by the community: It gives back a pageimage and not the URL-string. This way you can use it like this:

// get the first image instance of crop setting 'portrait'
$image = $page->images->first()->getCrop('portrait');

You can further use every pageimage property like 'url', 'description', 'width' & 'height' with it:

// get the first image instance of crop setting 'portrait'
$image = $page->images->first()->getCrop('portrait');
echo "<img src='{$image->url}' alt='{$image->description}' />";

And you can proceed further image rendering with it:

// get the first image instance of crop setting 'portrait' and proceed a resize with imagesizer
$image = $page->images->first()->getCrop('portrait');
$thumb = $image->width(200);

// or like this:
$thumb = $page->images->first()->getCrop('portrait')->width(200);

// and if you have installed Pia, you can use it here too:
$thumb = $page->images->first()->getCrop('portrait')->crop("square=120");

The only downside with this is that when you (as the site developer) have enabled the usage of DropDown-Selects in the images editor, you do not know the values the editors have chosen for the images.

As a workaround for this you can use the getCrop() method with a second param. This is a PW selector string. It can contain as many of the known pageimage options like 'quality', 'sharpening', 'cropping', etc, as you need, but none of them is required. But required is at least one setting for 'width' or 'height':

$image = $page->images->first()->getCrop('portrait', "width=200");
$image = $page->images->first()->getCrop('portrait', "width=200, height=200, quality=80");
$image = $page->images->first()->getCrop('portrait', "height=400, sharpening=medium, quality=75");

.

.

You can get the module from GitHub: https://github.com/horst-n/CroppableImage

(Better Docs are coming soon)


Screenshots

croppable-image_screens-01.jpg

croppable-image_screens-02.jpg
croppable-image_screens-03.jpg



Related Infos

A good setting in site/config.php for the AdminThumbs are: (height=>200 and scale=>0.5 !)

 

$config->adminThumbOptions = array(
  'width' => 0,
  'height' => 200,
  'scale' => 0.5,
  'imageSizer' => array(
    'upscaling' => false,
    'cropping' => true,
    'autoRotation' => true,
    'sharpening' => 'soft',
    'quality' => 90,
    'suffix' => array(),
  )
);
Edited by horst
added link to new PW 3 version
  • Like 33

Share this post


Link to post
Share on other sites

Thanks to the three of you for you work on this! Can't wait to test - will definitely be using it on a new site that is starting dev in the next couple of weeks. I'll let you know how it goes!

  • Like 2

Share this post


Link to post
Share on other sites

Thanks for this, folks. Looks great, can't wait to give it a try!

As a minor observation, you might want to repeat some of the recent fixes for Thumbnails module here too (strict standards, repeater permissions, etc.)

  • Like 2

Share this post


Link to post
Share on other sites

Very nice! As the thumbnails module got more and more out of date it faded from my default modules list. But I think this will be the replacement mighty soon.

  • Like 2

Share this post


Link to post
Share on other sites

How stable is this version? I plan to try this for a recent project that's going live soon. Thanks for the work put into this!

  • Like 2

Share this post


Link to post
Share on other sites

Would be great to build easy gallery fields with different thumbs or a imagefield for blogposts....really thumbs up.

will test asap!

  • Like 1

Share this post


Link to post
Share on other sites

Hey guys - I have just started using this and have a couple of issue:

Notice the way the image is transparent over the grey info bar?

post-985-0-96098200-1421094173_thumb.png

In thumbnail view, the crop button is not showing.

Also I have two croppable image fields and toggling the thumb/list view buttons on one change the view on the other - not sure if this is related to croppable image or not though.

post-985-0-94478100-1421094099_thumb.png

One more thing - might just be me, but I'd prefer to see the crop buttons just below the image - ie, above the description and tags fields.

Thanks!

Share this post


Link to post
Share on other sites

Hey @adrian, just to clarify:

1) in grid view (thumbnail view) you need to hover over the little headline (width x height), than this changes to "Edit" and you need to  click this to get into a little modal window that holds all crop buttons and all the text inputfields, for e.g. description, tags, etc. Does this not work for you? If not, what browser version you are using?

2) what admin theme are you using?

3)

One more thing - might just be me, but I'd prefer to see the crop buttons just below the image - ie, above the description and tags fields.

Is this related to the list view or the grid view, or both?

Share this post


Link to post
Share on other sites
1) in grid view (thumbnail view) you need to hover over the little headline (width x height), than this changes to "Edit" and you need to  click this to get into a little modal window that holds all crop buttons and all the text inputfields, for e.g. description, tags, etc. Does this not work for you? If not, what browser version you are using?

Good point - sorry I had seen that - I was confusing list view with thumbnails displayed vs grid/thumbnails view. I think it works as you have it, but I think things look a little ugly in list view when you don't have the field set to use thumbnails, but rather the full sized version - maybe that is why I am getting the image centered and overlapping the info bar above?

2) what admin theme are you using?

I am just using the standard default theme - PW 2.5.13

Is this related to the list view or the grid view, or both?

Probably doesn't matter in the popup for the grid view, but in the list view I think it would be more obvious for users, but not a big deal.

Share this post


Link to post
Share on other sites

Ah, I always use Thumbnails in Listview, have tried the fullsize images in Listview a while ago.

Yes, the (unhovered) titlebar is transparent and overlaps the image. Maybe we simply should make it opaque? Or do you think this few lines can be important enough to not get covered?

But anyways, I have to hand this over to @Martijn !

------

One more thing - might just be me, but I'd prefer to see the crop buttons just below the image - ie, above the description and tags fields. ( <= Related to Listview with fullsize images)

Probably doesn't matter in the popup for the grid view, but in the list view I think it would be more obvious for users, but not a big deal.

In Listview with thumbnails I like it as it is now, but in Listview with centered fullsize images it may look a bit better if the buttons are appear directly under the image and centered too, followed by the text inputfields. But I have to give this to @Martijn too :)

  • Like 1

Share this post


Link to post
Share on other sites
Or do you think this few lines can be important enough to not get covered?

I guess I don't understand why the look is different to a standard PW images field - ie opaque and not covering the image - I think it is important to see all the image.

Thanks for looking into these things Martijn!

Share this post


Link to post
Share on other sites

Notice the way the image is transparent over the grey info bar?

 

That's not a bug, it's meant to be like that. This wil result in more visual image and less UI (margin/paddings), it'll save you at least 45px height per image. Making it totally transparent can be an option, but i'm a little bit afraid text and buttons in the header will be hard to read.

 

One more thing - might just be me, but I'd prefer to see the crop buttons just below the image - ie, above the description and tags fields.

Problem is amount of crop variations, the length of the crop text (especially in European languages) and extra vertical space the crop should take due to repetitive buttons. In most cases it'll double the vertical space (I started this way), IMHO it's not an option.

  • Like 1

Share this post


Link to post
Share on other sites

@Martijn: ah, for me this makes sense: saving space with full images.

And with a lot of images so boringly showing repetitive cropnames throws away the focus from the thumbnails.

And that it is visually different from default images field is a plus.

@Martijn: have you also read that if you have two or more croppable fields on one page, toggling the viewmode (list/grid) always affects all fields?

  • Like 1

Share this post


Link to post
Share on other sites

@Martijn: have you also read that if you have two or more croppable fields on one page, toggling the viewmode (list/grid) always affects all fields?

No didn't read that. ( I'm a bad reader :unsure:  ) Oké will look into that, should not be hard to fix I guess....

  • Like 1

Share this post


Link to post
Share on other sites

Is there any particular feature from PHP 5.4 you are using? I think many are using Ubuntu's release cycle (5 year LTS from 2012), where there will be PHP 5.3. for two more years (of course possible to update to 14.04).

  • Like 2

Share this post


Link to post
Share on other sites

I can't remember why it was set to PHP >= 5.4.0.  (@owzim: can you remember it?)

I also have no server with PHP 5.3 at hand. Maybe you (or someone other) can edit the three *.info.json files to point to PHP>=5.3.8 and try if it runs or throws any error?

If not it will take a while for me to get ready testing this. But it is noted on my ToDo now.

Share this post


Link to post
Share on other sites

I could quickly set a shared host account via its config panel to run under PHP 5.3.28 cgi.

The CroppableImage Editor worked, - but I could not test all functions in depth. If you want use it in a none productional site with PHP < 5.4.0, simply change the values in the 3 *.info.json files

// from this
	"requires": "ProcessWire>=2.5.11, PHP>=5.4.0, FieldtypeCroppableImage>=82",

// to this
	"requires": "ProcessWire>=2.5.11, PHP>=5.3.8, FieldtypeCroppableImage>=82",
  • modules/CroppableImage/FieldtypeCroppableImage/FieldtypeCroppableImage.info.json
  • modules/CroppableImage/InputfieldCroppableImage/InputfieldCroppableImage.info.json
  • modules/CroppableImage/ProcessCroppableImage/ProcessCroppableImage.info.json

Share this post


Link to post
Share on other sites

Hello,

first of all thank you for this great module!

I still have a feature request though: It would be even greater if it would be possible to have the option to specify an aspect ratio instead of a pixel width and height. That would make this field perfect for my use case :)

Any chance to get this feature?

Cheers

Share this post


Link to post
Share on other sites

Looks very good guys! Its very good to see that finally the cropping module gets an upgrade!

I would love to be able to add some more (very simple) text fields to the images, in the likes of http://modules.processwire.com/modules/fieldtype-image-extra/ This is something that I think the regular image fieldtype should also include, but maybe you take a lead here :)

(My reason is that right now I'm working on a very media-rich site, with artworks needing titles, descriptions, and 3 distinct handmade crops. Separate pages aren't an option because the drag&drop is so much better. I currently tackled this by splitting the description string, but that seems counter intuitive.)

Share this post


Link to post
Share on other sites

@Eelke Feenstra

Especially for rich media sites I would suggest going for flexibility. So using pages would be the better plan. Drag and drop can still be managed with a pagetable.

Share this post


Link to post
Share on other sites

Hey,

actually there is no time, even not for thinking in depth about this request. But maybe this suites your needs better: https://processwire.com/talk/topic/8079-imagefocusarea/

Reading the description it does look like this one does not have any ratio option either though.

Nevertheless thank u very much for the tipp!  I might install it and check it out anyways.

Share this post


Link to post
Share on other sites

@Michael, dealing with aspect ratio is in most cases more the task of CSS. Could you explain more in depth what you are after, then maybe we can help you with other possibilities. 

Share this post


Link to post
Share on other sites

Not sure it was mentioned somewhere, but I can't find a "cancel" button when on the Editor. I know you can just close the tab/window, but hey I had to think about.

  • Like 4

Share this post


Link to post
Share on other sites

I had this thought with the Thumbnails module, too. I don't even know if clients would notice, that there's a new tab opened.

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