Jump to content

Recommended Posts

We are talking about two different things here then. You said templates (blog-post) but it seems you mean template files (blog-post.php)? What do you mean by layout? Do you mean the HTML markup or the layout of fields in the template? If HTML, Blog will not get in your way. You can use whatever template file you like but you need to associate your blog posts with the template blog-post. I don't know how much you've read up on the separation of these two concepts but you can have your posts use the template blog-post with a totally differently named template file or none at all. In a nutshell, Blog doesn't care about template files - just the templates. Btw, a couple of posts up I have provided a Gist of the method renderPosts() whose markup you can modify to suit your needs (if you are referring to the markup renderPosts() generates) and use that instead of Blog's renderPosts(). That will not stop you from using Blog's other methods, e.g. renderTags().

Share this post


Link to post
Share on other sites

@Peter Knight I can confirm that Kongondo's example gist works no problem. Can easily add mark up to the necessary parts of the function. In my case I've added divs to suit bootstrap. No problem. And if you wanted to create separate markup for a single post you could either do it with a separate function or with a conditional statement within the renderPosts() function.

  • Like 2

Share this post


Link to post
Share on other sites

@Kongondo 

Can confirm I meant blog-post.php. IE The template files. Best thing for me to to is grab some time and actually try it :)

Share this post


Link to post
Share on other sites

Peter, I've added a lot of custom fields to my blog-post template, so my template file for the blog post itself is going to have a lot of calls to the fields listed for the template so that I can't rely on the module to output everything I want in the way that I want. It should be totally possible, and the module has a lot of other features that make it worth my while (multiple authors, the dashboard, etc). Unless you're stripping even more off the blog than just the template output for the individual posts, I think I'd stick with using it. My 2¢!

  • Like 2

Share this post


Link to post
Share on other sites

@kongondo is the total blog-post count for the user stored anywhere?

I'm trying to list my authors (in a custom admin page) in order of post count (greatest to least). Anything you can think of that would do it? Thanks again!

I see "$authorPublishedCnt = count(wire('pages')->find("template=blog-post, created_users_id={$author->id}"));" in ProcessBlog.module line 1840, which seems about what I'm looking for... though I'd like to subtract unpublished posts (which I can do with math in a later line if necessary). Is there a way for me to access created_users_id in admin? I tried that and createdUser but they both threw errors.

I love how typing out a question to you almost always helps me think through it. Sometimes I'm lucky enough to be inspired to try something before I post the question. Other times, not so much.

So the call I ended up using was:

$points = count(wire('pages')->find("template=blog-post, created_users_id=$mobster->id"));

The trouble I was having was that I was comparing the user id to the page name. Doink!

Edited by creativejay

Share this post


Link to post
Share on other sites

Cool. But that will just show the number of posts they have but not (necessarily) sorted according to their individual posts count. For that you would need something like this...

$posts = $pages->find("template=blog-post, sort=created_users_id.count");//you might want to limit results depending on use case

//test it....it should output the list in DESC order...
foreach ($posts as $post) {

  echo $post->createdUser->title . ' - ' . $post->title . '<br>';
  
}

Count selectors – finding matches by quantity

http://processwire.com/api/selectors/#count

  • Like 1

Share this post


Link to post
Share on other sites

Hey, look at that! I stepped away before tackling the sort order and you did the work for me!

I have to add some posts for the other users to test this, since for now post count order is the same as the default. I'll report back in a few minutes. Just wanted to say my thanks!

Share this post


Link to post
Share on other sites

Btw, unrelated, note that it is possible to change the author of a post. When editing the post, just go to its settings tab and under 'Created by User' you can change the user.

  • Like 1

Share this post


Link to post
Share on other sites

Okay, I see your query was looking at blog-post, so the created_users_id.count applies to the field created_users_id which is part of a blog-post page.

What I'm actually looking to do is sort the user list by the total (published) posts attributed to the user.. so I need to build that attribution somehow (before the query).

What would you do? My brain keeps telling me I should create a new field for template user called user_post_count, and write a hook for each post save that would assign the value of created_users_id.count to that field. Is that too convoluted?

Share this post


Link to post
Share on other sites

That's exactly what that code does :-). Did you try it? Or am I missing something here? What do you want your list to show? Authors only? Or authors + their count of posts? e.g. John - 35, Mary 23, Simpson 5?

Edited by kongondo

Share this post


Link to post
Share on other sites

It didn't quite work as-is. The list it output was the top user and the title of a post, one line for each post. Then it sorted the next user's single post.

So it did sort correctly, but it didn't display the number of posts for that user and I only wanted one result per user.

So I attempted to use the sort filter but of course since I was still searching users, not posts, it wouldn't work.

In the screen below you see the table with the correct information but the wrong order. Beneath that is the order and information from your code.

admin-custom-page-user-list-by-published

Share this post


Link to post
Share on other sites

I see. The following should do it. It could probably be made simpler but can't think straight this late hour :D

//find blog authors
$authors = $users->find('roles=blog-author|superuser, sort=title');
//array to hold author TITLES and their posts' count
$authorsList = array();

foreach ($authors as $author) {
    //count number of posts by this author
    $authorPublishedCnt = count($pages->find("template=blog-post, created_users_id={$author->id}"));

    //we assume no two authors with identical TITLES, otherwise older will be overwritten
    //author title is $key and their post count $value
    $authorsList[$author->title] = $authorPublishedCnt;

}

//sort the associative array $authorsList by posts count ($value), DESC
arsort($authorsList,1);

//rest of your code here to loop through the sorted array above

Share this post


Link to post
Share on other sites

As written, that only indexes the post count: Array ( [0] => 6 [1] => 1 [2] => 0 )

Not sure why it won't let me assign my variable as a key. Will tackle it more tomorrow.

Edited by creativejay

Share this post


Link to post
Share on other sites

You have the author title in the array keys...But you have to first make sure that you have entered the 'titles' of your authors in their user pages, i.e. the 'Display name (first and last name) field that Blog adds to user pages otherwise the array keys will be empty :-). Again, we are using their 'titles' not their 'names'. However, if you want to use their names instead, just modify the code above like so...(but I prefer title :-))

//find blog authors
$authors = $users->find('roles=blog-author|superuser, sort=title');//sort doesn't matter here, so can remove
//array to hold author NAMES and their posts' count
$authorsList = array();

foreach ($authors as $author) {
    //count number of posts by this author
    $authorPublishedCnt = count($pages->find("template=blog-post, created_users_id={$author->id}"));

    //we assume no two authors with identical NAMES, otherwise older will be overwritten
    //author NAME is $key and their post count $value
    $authorsList[$author->name] = $authorPublishedCnt;

}

//sort the associative array $authorsList by posts count ($value), DESC
arsort($authorsList,1);

//output the author list and post counts
foreach ($authorsList as $key => $value) {
    #this is just for testing. Use your own markup of course
    echo 'Author Title: ' . $key . ' - Author Post Count: ' . $value . '<br>';
}
  • Like 2

Share this post


Link to post
Share on other sites

Thank you kongondo! As usual I can go to sleep trusting that the ProcessBlog Fairy will leave working PHP code underneath my pillow...

This seems to be the line that made the difference "foreach ($authorsList as $key => $value) {"

Got that working now! I'm sure I'll be back with something else soon! ;) Thanks again!

Share this post


Link to post
Share on other sites

Great Module! Thanks!

I miss one litte functionality - display related posts (or did I miss something?).

Maybe someone else needs this, so here is the code (I use this in a TemplateDataProvider):

  public function populate() {
    $limit = 3;
    $selector = array(
      'template' => 'template=blog-post',
      'id' => 'id!=' . $this->post->id,
      'categories' => 'blog_categories=' . $this->post->blog_categories,
      'tags' => 'blog_tags=' . $this->post->blog_tags
    );

    // find posts same tag AND category
    $related = wire('pages')->find(implode(', ', $selector));

    if ($related->getTotal() < $limit) {
      // find posts same category
      $related = $this->getRelated($related, $selector, 'tags');

      if ($related->getTotal() < $limit) {
        // find posts same tag
        $related = $this->getRelated($related, $selector, 'categories');
      }
    }

    $this->related = $related;
  }

  private function getRelated($related, $selector, $remove) {
    $selector['id'] .= '|' . (string)$related;
    unset($selector[$remove]);
    $rel = wire('pages')->find(implode(', ', $selector));

    return $related->import($rel);
  }

  • Like 5

Share this post


Link to post
Share on other sites

Thanks for this justb3a. We currently don't have this functionality. It looks like something I should add. I'll consider it.

  • Like 1

Share this post


Link to post
Share on other sites

Regarding "related posts", I also think that it's a pretty important for any blog out there. As a blogger you want readers to stay as long as possible and visit as many posts as possible. A feed of related posts is a great way to achieve that.

Not sure if it's still up-to-date, but I've used this Gist by Soma in some projects a while ago, mainly for the scoring part :)

  • Like 2

Share this post


Link to post
Share on other sites

I just noticed that a superuser who created 9 pages that are unpublished OUTSIDE of the blog in the tree has a listing of 9 pages as pending in the Blog / Author dashboard. Not sure why, as the module seems to limit it to the blog-post template. I thought I'd mention it.

Share this post


Link to post
Share on other sites

I just noticed that a superuser who created 9 pages that are unpublished OUTSIDE of the blog in the tree has a listing of 9 pages as pending in the Blog / Author dashboard. Not sure why, as the module seems to limit it to the blog-post template. I thought I'd mention it.

Well that's just plain impossible unless you changed something :D. Just to be sure, I've just tested it...

  • Like 1

Share this post


Link to post
Share on other sites

Regarding "related posts", I also think that it's a pretty important for any blog out there. As a blogger you want readers to stay as long as possible and visit as many posts as possible. A feed of related posts is a great way to achieve that.

Not sure if it's still up-to-date, but I've used this Gist by Soma in some projects a while ago, mainly for the scoring part :)

Thanks for reminding me about this one (I actually forked it a long time ago and forgot about it!! Never thought to use it). Interesting approach Soma uses  - raw MySQL (although I don't think I'll have to hook into anything if I adopt this). I'll compare it more closely to justb3a's plus any other ideas I might have and make a decision...

Share this post


Link to post
Share on other sites

Also wondering whether to define a 'related post' as only one that has this matching 'tag' AND this matching 'category' to the exclusion of also has either this matching 'tag' OR has this matching 'category'...Hmm, maybe let the dev decide...

Edit:

Also wondering if can/should use or-groups here? Just my loud musings here in case I forget...ignore me :-)

Edited by kongondo

Share this post


Link to post
Share on other sites

Well that's just plain impossible unless you changed something :D. Just to be sure, I've just tested it...

I agree, I'm looking at line 1841 in my (untouched) ProcessBlog.module. I see no reason that pages with template 'form-builder', 'blog', 'blog-widgets', 'swmb_error', or 'admin' should show up in that list. However, when I add 'parent=/blog-posts/' to the filter, the pending count returns to 0.

I'm just the black child fluke-finder. ;)

Share this post


Link to post
Share on other sites

I'm searching back through this discussion and not finding if anyone ever came up with a solution that prevented blog-author from editing other users' posts (other than their own).

Was anything ever worked up or around to limit people to editing just their own content?

EDITED TO ADD: Okay, I found this which blocks the users from editing other people's content:

https://processwire.com/talk/topic/3875-module-to-add-userid-to-pages-and-control-edit-permissions/?p=37915

I'm getting there!

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