Jump to content

Recommended Posts

Hmm it must be something to do with the newer comments module for sure.

I should have stated earlier that i am also running pw 2.5.10 dev branch.

I tried backing up to an earlier installation and reinstalling with the same 2 issues with the tables field_blog_comments and field_blog_comments_votes

Share this post


Link to post
Share on other sites

Thanks Alex for catching this.

I can confirm this behaviour only happens in the dev branch since the addition of the updated FieldtypeComments. Ryan managed to break something :-). Hey, the new fieldtype is still under development. I will bring this to Ryan's attention.

Meanwhile, a workaround that I have tested is to first install the stable branch PW, install Blog, upgrade PW to dev branch. Works fine.

FYI the message logs for dev branch (unsuccessful upgrade of blog_comments)

2015-01-06 18:07:29	lightning_admin	http://curium-kcu.lightningpw.com/processwire/blog/	Updating schema version of 'blog_comments' from  to 4
2015-01-06 18:11:06	lightning_admin	http://curium-kcu.lightningpw.com/processwire/blog/	Updating schema version of 'blog_comments' from  to 4
2015-01-06 18:17:05	lightning_admin	http://curium-kcu.lightningpw.com/processwire/blog/	Updating schema version of 'blog_comments' from  to 4

Compare that to a successful one..

2014-11-30 01:51:37	kongondo	http://localhost/pb/pb/blog/	Updated schema version of 'blog_comments' to support website field.
2014-11-30 01:51:37	kongondo	http://localhost/pb/pb/blog/	Updated schema version of 'blog_comments' to support website field.
2014-11-30 01:51:37	kongondo	page?	Updated schema version of 'blog_comments' to support website field.
2014-11-30 01:51:37	kongondo	page?	Updated schema version of 'blog_comments' to support website field.
2014-11-30 01:54:34	kongondo	http://localhost/pb/pb/blog/	Updated schema version of 'blog_comments' to support website field.
2014-11-30 01:54:34	kongondo	http://localhost/pb/pb/blog/	Updated schema version of 'blog_comments' to support website field.
2014-11-30 01:54:34	kongondo	page?	Updated schema version of 'blog_comments' to support website field.
2014-11-30 01:54:34	kongondo	page?	Updated schema version of 'blog_comments' to support website field.
2015-01-06 17:46:32	kongondo	http://localhost/pb/pb/blog/	Updating schema version of 'blog_comments' from 1 to 5 (FieldtypeComments)
  • Like 3

Share this post


Link to post
Share on other sites

Awesome! Nice one man! You are a bloody marvellous chap. Some might say a gentleman and a scholar... I most certainly would say so!

I shall follow your process process down to the wire.

  • Like 3

Share this post


Link to post
Share on other sites

Update: Blog version 2.3.1

Bugfixes

Thanks to @matulkum, fixed this bug (thanks @bwakad) where...unparsed HTML would be output in Blog Posts/Categories/Tags Dashboards in multilingual ProcessWire environments. 

Additions

As per https://processwire.com/talk/topic/7403-module-blog/?p=83971. Thanks to @Gazley, added 'post_small_tag' option to renderPosts(). Enables developer to select HTML tag to wrap around a 'small' Blog Post, i.e. a post excerpt/summary. Value should be left blank if no tag is desired. Especially useful if using the option 'post_small_allowable_tags'. The default tag is '<p>'. Use option as:

//$options = array('post_small_tag' => 'div');//note we enter the tag only without the angle brackets!
//render a limited number of summarised posts
$content .= $blog->renderPosts("limit=5", true, $options); 

Requests

Thanks to @loopyloo, added MarkupBlog frontend demo screenshot to README. See post #304-312 for why...

  • Like 2

Share this post


Link to post
Share on other sites
Option 2.

Add your custom fields to the template 'blog-post' and use the module 'Page Edit Field Permission' to hide your custom fields as relevant to your Posts types A - D. In your template files, you will need to echo your custom fields separately from renderPosts(). I think I would go for this option since it requires the least work and you only have 1 template to deal with..In your template file you would only echo out your custom fields if they were not empty.

Finally getting back to this project, and I see you tested this with a lot of success. I think I will give this a go. I promise to report back.

I'm also very excited to see the other features you've added since I last sat down to play around with the blog module, because you've taken care of so many things that were going to be a bother in my case. Thanks again!

Share this post


Link to post
Share on other sites

Hi hi hi,

Quick question which will either be a yes or no and if it's a yes hopefully it will be quite simple for someone to answer...

I'm aware that styling is easiest by just using CSS, however I am using bootstrap so would love to be able to change the markup if that is at all possible. Haven't seemed to have found anything to say there is an easy way of doing this. It's just that based on my design I need to have a div class="container" within div class="post" for each post.

Otherwise I am going to have to do a whole load of mixins and stuff.

This isn't to detract from the module as it is the tits. Just a question to hopefully make my life easier.

Thanks in advance.

Share this post


Link to post
Share on other sites

Not sure I get what you mean by

.... I need to have a div class="container" within div class="post" for each post..

Do you mean this

<div class='post container'>My post</div>

Or this?

<div class='post'>
  <div class='container'>My post</div>
</div>

Both can be achieved by using jQuery if you don't mind manipulating the DOM using js.

If the former (add a class using jQuery .addClass())

$("div.post").addClass("container");

If the latter (add an inner wrapper using jQuery .wrapInner())

$("div.post").wrapInner("<div class='container'></div>");

Share this post


Link to post
Share on other sites

Thanks for the super speedy reply Kongondo! Very grateful as ever.

Ok, so currently there isn't a away to add or adjust the markup elements via the options array?

Hmm... I have this issue in my head with doing it with javascript because of the extra bloat etc. But then I guess it really isn't adding that much and the rest of the site relies on javascript to run so this wouldn't be too much of a bad thing using it for this purpose as other things would break too.

Share this post


Link to post
Share on other sites

No, you can't adjust that markup via options.

There's other ways of doing it on the PHP side though, making it more foolproof than doing it client-side.

  1. See option #3 in this post (writing your own code to render posts): https://processwire.com/talk/topic/7403-module-blog/?p=83119
  2. Maybe using str_replace: See this post by DaveP: https://processwire.com/talk/topic/7403-module-blog/?p=78348
  3. Copy and modify the method renderPosts() into your own function which you can include in your template files

Using #3 above, you can continue using the rest of  MarkupBlog methods such as renderCategories() together with your own modified renderPosts(). If this doesn't make sense just ask :-)

Edited by kongondo
  • Like 1

Share this post


Link to post
Share on other sites

I think #3 sounds best.

So effectively I guess I can just copy it to my global _func.php file and then drop the $this instance and I should be good to add to the markup?

Also one other thing I have been trying to get the featured image of renderPosts() to show but cant seem to figure it.

Have enabled tags in blog_image field and left the featured options as default. Have tried adding the tag featured to the image I want as featured but it is not showing.

Sorry for all of these questions. I'm having a bit of a moment these last few days.

Share this post


Link to post
Share on other sites

Pretty much, but with a few additions as well. I have created a Gist of the renderPosts() function here:
 
In the demo blog-post.php and blog-posts.php you could use it as shown below (assumes you've already included the function)

//assumes function renderPosts() already included in page
$content .= renderPosts("limit=5", true, $options);//using our function above//blog-posts

$content = renderPosts($page, '', $options) . $blog->postAuthor() . $blog->renderComments($page->blog_comments) . $blog->renderNextPrevPosts($page);//blog-post

 
For featured image, the default is off (0) :-). So, you need to add an $options array with values for featured image 1 or 2 for the type(s) of post where you want a featured image (i.e. small or large). Below are the defaults:

//display post's featured image: 0=off,1=top(above post-headline),2=bottom(first item in post-body)')
$options = array('post_small_image' => 0, 'post_large_image' => 0);//these are the defaults -> off (zero)

Btw, note that for large posts you cannot use an embedded image as the featured image. You will need to designate a featured image. For small posts, both embedded and images tagged 'featured' will be picked up as featured images.

Edited by kongondo
  • Like 1

Share this post


Link to post
Share on other sites

I'm thinking of using this. Can anyone suggest a fairly representative and recent blog site based on it which I can show my client?

I realize the best answer is probably to spin up a new site but something real might make more sense to them.

Thanks!

Share this post


Link to post
Share on other sites

@Kongondo thanks for all of this! I will take a look into it and stop nagging you now!

@SteveB I'll have something up very shortly so will update when it is there. In the meantime, no doubt someone else will point you towards some examples when they see your post. I'll be working on the blog the next day or 2 though.

Share this post


Link to post
Share on other sites

@Creativejay,

Did you try my option 2 suggestion above? I tried it and it works brilliantly (tested on lightning.pw so can give you access before the test site expires) .

Sorry I didn't see this at the time to play in the example you built. I'd love to know more about how you set this up, if it's not too much trouble.

Share this post


Link to post
Share on other sites

It really is straightforward if you follow the the module 'Page Edit Field Permission' instructions :-)

  1. Create all your extra fields for your Categories A - D
  2. Add those fields to the template 'blog-post'
  3. Create 3 roles . I say three since as per your description Category B and D seem to have the same fields? If not, create 4 roles and give them distinct names
  4. Install the module 'Page Edit Field Permission'. Make sure to read its instructions.
  5. In its configuration screen use the 'Handy Tool....' to create permissions for all your 'blog-post' fields that you want to limit access to. For instance, if you want all your users with the roles Categories A -D to be able to view the 'title' field, then there is no need to create a permission for it. 
  6. The module will create permissions prefixed with 'page-edit-', e.g. if you ticked 'blog_body' as one of the fields in that screen, a permission 'page-edit-blog_body' will be created.
  7. Edit each of the roles you created in #3 and check the relevant permissions allowed for those roles. (i.e. give the roles access to edit selected blog fields).
  8. Edit and assign your users the different roles your created in #3. You can test with some dummy users, e.g. Jane, Samra, Onuko, Shah to represent your four Categories/Roles. Also give them the role 'blog-author' (needed by Blog).
  9. Edit the template 'blog-post'. In the Access tab, you should see the four roles created in #3. If they will all have 'view pages', 'edit pages', 'create-pages' and 'add children' privileges, then rather than granting these to each role, just assign the four privileges to the role 'blog-author' in that same screen. This is a template level access you are granting.
  10. Try logging in as each of your four dummy users. Edit a blog post. You will notice some fields are hidden depending on the role that user was assigned. Logging in as a superuser enables you to see all fields.

That's it really... O0

  • Like 1

Share this post


Link to post
Share on other sites

So are you saying you will have four fixed categories? A - D? And each of your posts will belong to only one of those categories? If yes to all, then the easiest way (but maybe confusing) is to create your 4 categories, create your extra fields and add them all to the 'blog-post' template. Then, when rendering posts, pass a PageArray filtered according to your categories to renderPosts() to display. The problem with this approach is that you may end up with lots of fields some of which will be empty depending on the post category and this may confuse your editors. I am not sure if they could be hidden using PW show/if/dependency. I can't think of any other ideas atm. Otherwise, you might have to modify MarkupBlog to suit your needs.

Share this post


Link to post
Share on other sites

Actually, maybe you could group the categories' fields using fieldsets! Would that work? So, you would have 3 fieldsets for categories B - D. The normal landing edit page would be for category A. I'll see if I can test this. 

Share this post


Link to post
Share on other sites

Something like this. Only 3 FieldSetTabOpen. For Category A we just rename 'Content' to something else in the template blog-post advanced settings.

Category A

post-894-0-16267500-1421840421_thumb.png

Category B

post-894-0-29651200-1421840422_thumb.png

Category C

post-894-0-41164100-1421840423_thumb.png

Category D

post-894-0-36555100-1421840424_thumb.png

  • Like 1

Share this post


Link to post
Share on other sites

Thanks a bunch Kongondo! I added the extra fields for field type A to a second tab, because I didn't want to distract from the category select field - I was afraid folks would miss that if I didn't put it right at the top! I think I can keep it to two group types.

Now back to modifying the output with custom templates. Kongondo, thanks as always for the quick support. You're a star!

Share this post


Link to post
Share on other sites

@Kongondo

If there was acase where we were using completely all our own templates, do you think the Blog Module still has benefits?

I know the dashboard is very useful ... is that the main feature we'd still use?

Share this post


Link to post
Share on other sites

@Peter,

In that case ProcessBlog wouldn't work. It has to find 'blog posts' by the template 'blog-post' rather than their parent because depending on the blog style you selected, the parent might not be a blog page. E.g. In blog style 4, the parent is the root page. The only way to differentiate blog posts in that scenario is by their template.

What did you have in mind?

Share this post


Link to post
Share on other sites

What did you have in mind?

One of my clients has some pretty specific layouts in mind. I feel more comftrable creating the layout directly inside my own templates.

What I had in mind was to replace the various blog php templates with my own code. 

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