Jump to content

Recommended Posts

Hi

I have problems installing this module. I tried it with the latest dev branch 2.5.25 on my development installation and also trying the installation with a clean install of PW. When I submit the settings of the module and go to Blog dashboard I get the error: "Field does not exist: blog_date". No fields or templates of the blog are created and no template files are copied into templates-directory. What might be the problem?

Share this post


Link to post
Share on other sites

Thanks Ipa,

A recent commit to ProcessModule.module in PW dev branch is the cause. Otherwise Blog works fine with versions up to 2.5.24. I have notified Ryan. Basically what is happening is that after that commit, Blog's configuration data is not properly saved to the database so it thinks Blog is already fully installed and it tries to load the dashboard (bypassing the install process). The error about the date is that it is trying to load the archives dashboard, sorting posts by 'blog_date', which of course, at that point does not exist as install did not run... :-)

Share this post


Link to post
Share on other sites

Hello,

I have blank blog pages after installation. It seems to be ok in admin panel, I can add posts etc, but all blog pages are blank for the user.

What can cause this problem? How to reinstall this module?

Kind Regards

Share this post


Link to post
Share on other sites

Hi chuguruk,

Welcome to the forums. I am not sure how familiar you are with ProcessWire. ProcessWire does not output anything (in the front-end) unless you tell it to, and even then, only what you tell it to. It is the same with Blog. Unless you either use your own code or MarkupBlog (part of the Blog module) to output your Blog, 'all Blog pages will be blank'. To get you up and running quickly, try installing Blog with the option to install demo template files. Instructions on how to install/reinstall/uninstall Blog are documented here. Documentation about how to use MarkupBlog can be found here.

Let me know if you need further information.

Share this post


Link to post
Share on other sites

So here we go,

Manfred62 asked me to push the german translation fo this great addon for processwire...and deliver it with the PW language files on github.

So i started tonight - and fin some little things here and there.

Done a pull request on git for the first one i found:

https://github.com/kongondo/Blog/pull/20

added two pics that show the difference...

for the germant translation i'll take some free evenings since with the installer there is much more text than the first versions ;)

By the way install 2.3.4 runs great and module is for shure great, too!!

Best regards to Kongondo for this big piece of  work - glad to could contribute a little with some lang files! ;)

post-2327-0-72986300-1430951046_thumb.jp

post-2327-0-99294700-1430951033_thumb.jp

  • Like 2

Share this post


Link to post
Share on other sites

So back again,

get some sparetime to contribute to this one.

It's a real beast now with many strings to translate....and i added a few one, too..... ;)

https://github.com/kongondo/Blog/pulls

But here we are.

Complete DE translation for the actual Blog version 2.3.4 (and it's comming pullrequests with additional strings for archive, and pages).

+ Translated SchedulePages module to use both combined.

Important Notice on the main translation thing with the blogmodule:

- Some Strings are taken from the pagetitels of the autogenerated pages for eg. "cathegories" or "archive" so please use the installation step with renaming the parents correct or rename the titels later.....but not the names... ;)

- CleanUp Ultility is not complete translated because it's only a superuser thing wich should be used with care and knowlegde so don't see a real effort to translate this rarely used function...

-Some Strings are not translateable since the where automatic generated on templates and fields so please translate these, too - if needed...

Have fun - Thanks again to kongondo

ProcessBlog-schedulePages.zip

  • Like 1

Share this post


Link to post
Share on other sites

Thanks for these mr-fan. I am a bit tied up at the moment but hope to look into these by next week.

Share this post


Link to post
Share on other sites

Maybe i've it wrote up wrong.....with the module all is OK

Only the pull request add some strings.

The extra points on the whole translation topic are optional for other users, since some English names have to stay while the are auto generated via the installation....but this should be no real problem.

Regards mr-fan

Share this post


Link to post
Share on other sites

First. @kongondo, thank you for these modules. 

I have encountered a small bug in the MarkupBlog module (I believe).

When I invoke renderPosts() with just default options, it renders my example set of posts just fine.

When I use the API to invoke the option to make comments (and categories) appear in a post's footer, however, renderPosts() creates some broken content. Specifically, the $numCommentsStr (line 965 in MarkupBlog.module) comes back with HTML-as-text. 

Background:

I installed a new server with PW 2.6, which I then used to DL and install (the latest?) ProcessBlog via the Admin interface. I chose the demo-files option in phase 2, then switched to my own template code, just using the API (and here's my blog.php ):

$blog = $modules->get("MarkupBlog");
$myOptions = array(
        'post_comments' => 2,
        'post_author' => 0,
        'post_categories' => 2,
        'post_large_headline_tag' => 'h3',
);
$content = $blog->renderPosts("limit=11", false, $myOptions);

Straight forward and simple, (inheriting the same appearance code as the main PW example site).

Meanwhile, rendering a single post with the same option (put the comment count in the post's footer) works just fine. Here's that file ('blog-post.php'):

    $blog = $modules->get("MarkupBlog");

    $blogConfigs = $modules->getModuleConfigData('ProcessBlog');

    $renderComments = $blogConfigs['commentsUse'] == 1 ? $blog->renderComments($page->blog_comments) : '';

    $myOptions = array(
        'post_comments' => 2,
        'post_author' => 0,
        'post_categories' => 2,
        'post_large_headline_tag' => 'h3',
    );

    $content = $blog->renderPosts($page, false, $myOptions) . $renderComments . $blog->renderNextPrevPosts($page);

I examined the module code and couldn't determine what is corrupting the $numCommentsStr. I did notice a difference in the syntax used to render the same element (top uses an if statement and just appends to $out, while bottom uses a ternary op and temp var and concats a bunch of stuff at once), and the odd re-usage of a var $comments (which everywhere else is used to hold an array of comments), 

It is interesting to recognize that the badly-rendered post (the one with comments) renders out HTML that actually belongs to the post from the previous iteration.

Here's the screenshots (multiple page with bad content and single page with good render):

ProcessBlogMarkupCommentsBug.png

ProcessBlogMarkupCommentsBug2.png

I'm a vet C++ programmer, just ramping up to really learn PHP, so forgive me if I'm missing something obvious. Maybe it's a combination of having two non-default options (no Author output + bottom comment count)-- I haven't tried all combos to help with the debugging. I thought I'd call on more experienced PHP folk first...

TIA for any comments.

Share this post


Link to post
Share on other sites

@Metadope,

I'll test this and get back to you. It may not be for a few days though...

Btw, this line is only in the demo since the demo cannot know the type of 'blog style' selected by the user. Otherwise, you don't need it in your own template files since you know whether you installed blog with the comments feature..

$renderComments = $blogConfigs['commentsUse'] == 1 ? $blog->renderComments($page->blog_comments) : '';

So, just render blog comments if you need to without the conditional check :-)

Share this post


Link to post
Share on other sites

@all....Please rest assured I haven't forgotten your requests/concerns. I am still totally swamped with other stuff. Hoping to free up some time soon to address all pending issue. Thanks for your patience.

Share this post


Link to post
Share on other sites

Good afternoon, fellas,

sooo I installed the blog module, and it works totally fine, kicking ass and everything, I love it.

I'm currently working on a site which is not a blog, but has a blog- subpage, which I got rolling. But what happens, or more like what do I do, if I want a second Subpage on my site which uses the blog - functionality? is there a way to achieve this?

consider the following page tree:

Home

stuff -> regular  content

stuff2-> Blog 1

stuff3 -> Blog 2

 

.. and so on.

so basically I would want two subpages on my site on which I would be able to publish blog posts independent from each other, which (in my opinion) would mean that I could tell the blog module at a certain point to publish a post on either one of these two pages.

Help would be much appreciated.

Best regards, 

DeM

/edit:

so I kinda had an idea for an approach to a solution to my problem, my thought was, that I could use two templates, which output blog posts by category, so basically I'm looking for a function which outputs posts with category "blog1" on the first page and in a second php script, one that outputs posts with category "blog2" on a separate page.

so far though, I couldn't find anything about that in the documentation, I only found output filtered by post author, does the same apply to post category?

//edit 2: I managed to do that, just had to change a few lines in one of the php files. Finally, everything works, and I have to admit, I am totally impressed. this module kicks ass in any way imaginable. Thank you so much Kongondo.

Greetings from Germany,

DeM

  • Like 1

Share this post


Link to post
Share on other sites

@kondongo

I'm ProcessWire noob and I can't figure out where I'm going wrong.

I've installed the modules as described in the read me file and it appears to have worked.  I've selected the settings (Step 1) that I want to use, but when I go to "Blog" in the admin I get the error message shown in the screen shot:

post-3491-0-45902200-1433880998_thumb.pn

I've tried Googling it, but was left empty handed.  Any help would be much appreciated.

Thanks!

Share this post


Link to post
Share on other sites

@simplesequence - welcome to PW - sorry for the rough start, but looking at your screenshot I see that you are running v2.3. According to the modules directory, kongondo's blog module isn't compatible with this version. It requires 2.4+

PW's current stable version is 2.6.1. Is there any reason you are running 2.3?

  • Like 1

Share this post


Link to post
Share on other sites

I have enabled tags for blog_images field to use the featured image feature, but the tags are not saving. What could be the reason for tags not saving? I am using the latest dev version 2.6.4.

Share this post


Link to post
Share on other sites

Any plans to add gravatar or avatar to comments and if not, am looking to implement one for my website, you don't mind pull-requests ?

  • Like 1

Share this post


Link to post
Share on other sites

Any plans to add gravatar or avatar to comments and if not, am looking to implement one for my website, you don't mind pull-requests ?

Hi Adrian are there any plans for comments to add Gravatar support, I really need it for my site, so I want to know if there's plan for it so I can look at your code and if not, so i can advance and integrate one with your comment and send you a PR. it makes me feel comfortable seeing avatars on my comments. 

Share this post


Link to post
Share on other sites

Hey Sephiroth - remember this is kongondo's module, not mine but I am sure he would appreciate PRs. 

I know that he has been very busy with other things lately and hasn't had much time in the forums, but hopefully he can review and accept a PR fairly quickly still.

Share this post


Link to post
Share on other sites

Hi  When installing ProcessBlog & MarkupBlog I selected the blogstyle 4 (add post as child of 'Home').   I rearranged my pages and now it should be blogstyle 1.  Add post is still as child of 'Home'!   How can I change the blogstyle from 4 to 1 ?

hansv

Share this post


Link to post
Share on other sites

Hello, 

I have some trouble with the blog-author role. 

 I have also an editor role which can edit and add the pages. 

exampleuser 

       - editor-role

       -blog-author

but only superuser can edit the Pages. How I can handle this problem ? 

Thanks 

Share this post


Link to post
Share on other sites

Has anyone gotten a slow loading time with a timeout ? When I go to the blog dashboard on a local install, it wont load. In the blog dashboard however, if I go to admin/blog/posts I can see the posts, I can also get to settings, authors etc. but not dashboard. Its very odd. :-(

Share this post


Link to post
Share on other sites

This is after I imported 420 posts using the wordpress migrator.  The posts were migrated correctly and all fields match. Its just an odd bug. Could it be its installed locally? Its very odd. I can go to /admin/blog/posts and categories, tags, authors, settings, cleanup but the dashboard times out. It will load forever and then fail. :-(

Share this post


Link to post
Share on other sites

I turned on debug and saw that the memory_limit was under what ProcessWire was requiring. 

I am running Mamp and I just increased the memory_limit and the maximum_execution time. I had to crank it to 500M in order for it to work and 60 seconds. 

 

Is that normal? 

 

I went back and adjusted ProcessBlog.module $posts to limit=10 and still showing a long load time.

Share this post


Link to post
Share on other sites

I turned on debug and saw that the memory_limit was under what ProcessWire was requiring. 

I am running Mamp and I just increased the memory_limit and the maximum_execution time. I had to crank it to 500M in order for it to work and 60 seconds. 

 

Is that normal? 

 

I went back and adjusted ProcessBlog.module $posts to limit=10 and still showing a long load time.

Doesn't sound right at all. 500M makes it sound like all your posts are getting loaded into memory all at once.

Taking a quick look at the ProcessBlog.module, there's actually a bunch of queries without proper limits defined, such as this one for an example: wire('pages')->find('template=blog-post, include=all, sort=-blog_date, parent!=7'). If you want to debug this further, I'd try disabling all queries that find blog-posts without a proper limit, and see if that helps.

Kongondo would know better how to handle these, if they're the issue here. Loading all posts into memory at once definitely shouldn't be the only option :)

  • Like 1

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