Module: Blog

[kongondo]

You won't find anything specific to Blog. I suggest you search the forums at large for something like this:

'limit page editing to the user that created that page'

https://processwire.com/talk/topic/3271-can-i-limit-page-editing-to-the-user-that-created-that-page/

Read that whole thread and modify the autoload module to suit your needs. 

[creativejay]

Thanks! I edited my question above to include the link to the discussion whose module I used.

I'm reaaaaally close! Of course not as close as I thought I was about 5 hours ago.. XD

[kongondo]

Regarding "Related Posts", I have been able to implement this using one line of code , OK, not quite but I have chosen a different route from the previously suggested code. Thanks for the inspiration and ideas though!  I will wrap this in a new renderRelatedPosts() method in MarkupBlog. In case you are wondering, the most important line of code is this:

$related = $pages->find("template=blog-post, blog_categories=$page->blog_categories, blog_tags=$page->blog_tags, id!=$page->id, limit=3, sort=-blog_date");

I'll post details later but I will make this configurable in the new method, i.e. add options to find related posts by 'tag' OR by 'category' OR 'by both tag AND category'. There will also be an option for limit as well as sort, i.e. if limiting, e.g. to 3 related posts, what's the criteria for your '3 most important related posts'? The default will be 'most commented on related posts' sort by latest posts (blog_date).

Then, similar to the 'Related Categories', 'Related Tags' and 'See also' output that you can see in the demo Blog template files running on the left hand side navigation, one will simply need to use the method renderNav() to display Related Posts as follows in the template file 'blog-post.php':

$subNav .= $blog->renderNav(__('Related Posts'), $related);

Just wanted to post these ideas before I finalise the code in case there is something I am missing? Thanks.

Edited January 26, 2015 by kongondo

[justb3a]

Sounds good!

In my installation I deactivated comments, that's why I havn't though about the option 'most commented on related posts' (but I really like the sort option). I have not that much blog posts so I need the following combination: find related posts by 'both tag AND category', by 'category' and by 'tag' (in that order) to fill my list.

[kongondo]

Good catch; sorting by 'most commented on related posts' cannot be the default since not everyone will have activated Blog Comments. I have changed the default to sort by latest post...

[kongondo]

Update: Blog version 2.3.2
 
Additions
Thanks to idea by @justb3a, I have added a new method renderRelatedPosts() to MarkupBlog.  The method returns a PageArray of posts related to the post currently being viewed or the specified blog post/page. (if related posts found, otherwise returns null). It takes four arguments as follows:

renderRelatedPosts(Page $post = null, $relatedBy = null, $limit = null, $sort = null) 

1. $post: The post whose related posts will be returned. Defaults to the current page if none specified. 
 
2. $relatedBy: This sets the criterion for determining how other posts are related to the current post. There are 3 possible options here:
 
a. $relatedBy = 1: posts are related by both tags AND category. This means that in order to be considered as related to the specified post, the posts to be returned must have at least one tag and at least one category in common with the specified post. This is the default relation criterion.
 
b. $relatedBy = 2: posts are related by tags ONLY. Means that at least one tag has to match the specified post's tags.
 
c. $relatedBy = 3: posts are related by categories ONLY. Means that at least one category has to match the specified post's categories.
 
3. $limit: Number of related posts to retrieve. Defaults to 3 posts.
 
4. $sort: This determines the related posts to prioritise in the find. It is especially useful when you set a $limit. It defaults to sort by blog_date DESC, meaning latest posts. You can use any other valid ProcessWire sort value, e.g. sort by title, sort by 'most commented on posts' [see example below], sort by random, etc.
 
The method returns no markup and its output can be used in a variety of ways.
 
Examples

#RELATED POSTS

##1. used in conjuction with MarkupBlog's renderNav()
##similar to 'Related Categories' in the left-hand navigation in demo Blog 'blog-post.php' template file

//CALL THE MODULE - MarkupBlog
$blog = $modules->get("MarkupBlog");

//use defaults. Related posts limited to 3, related to this post by BOTH tags AND categories, ordered by blog_date DESC
$related = $blog->renderNav(__('Related Posts'), $blog->renderRelatedPosts());

//use renderNav() markup
echo $related;

//find the 'most commented on' posts related to this post by category
$related = $blog->renderNav(__('Related Posts'), $blog->renderRelatedPosts(null, $relatedBy=3, null, '-blog_comments.count'));

//find 7 posts, ordered Alphabetically by title, related to this post by tag
$related = $blog->renderNav(__('Related Posts'), $blog->renderRelatedPosts(null, $relatedBy=2, $limit=7, 'title'));

##2. used outside blog-post.php or even outside Blog pages

$post = $pages->get(2550);

//find 5 random posts related to the specified post by BOTH tags AND categories
$related = $blog->renderNav(__('Related Articles'), $blog->renderRelatedPosts($post, null, $limit=5, 'random'));

//find the 3 'least commented on' posts related to the specified post by tags
$related = $blog->renderRelatedPosts($post, $relatedBy=2, null, 'blog_comments.count');

//find 3 posts related to the specified post by tags AND categories
$related = $blog->renderRelatedPosts($post);

//use custom markup
foreach($related as $r) echo $r->title . '<br>';

Screenshot

 
Currently in dev branch only for testing.

[alexm]

Here's a quick question...

I have the URL structuring set up as option 1

So blog/posts/post but would like to change to blog/post

Can I just move the posts out of the post parent page. Or would I be right in assuming it would be better to use a htaccess rewrite and rewrite blog/posts/post to blog/post ?

Thanks all

[kongondo]

Is this already live? Are you not able to reinstall and select style 2?

[loopyloo]

Having a problem uninstalling. When you uninstall you have to manually delete fields etc, BUT as you have already uninstalled you cannot access blog-> cleanup.

Could you please add a link or text above uninstall to ask "Would you like to delete the fields as well?"

as I cannot now reinstall:

SQLSTATE[23000]: Integrity constraint violation: 1062 Duplicate entry 'blog-author-30' for key 'name_parent_id'

Tried manually deleting everything in the database but still get this error

Thanks

[kongondo]

  On 1/27/2015 at 6:03 PM, loopyloo said:

Having a problem uninstalling. When you uninstall you have to manually delete fields etc, BUT as you have already uninstalled you cannot access blog-> cleanup.

Well this is not true...at least not if you followed the instructions to the letter  .

The instructions are very clear. There is no need to manually uninstall anything in Blog 2. Uninstall is a two step process

(i). Use the Cleanup first

(ii) Uninstall the module

https://github.com/kongondo/Blog#uninstall

  Quote

Uninstalling Blog is a two-step process. If you are logged in as a superuser, you will see a Blog menu item called Cleanup. It will lead to a screen with info about all the Fields, Templates, Pages and Role you are about to delete. It will also list the Blog Template Files that, if you wish, you can also delete. This utility is also useful when you want to try out the different Blog styles without uninstalling the whole Blog module. It returns Blog to the state similar to when you first installed the module. Of course, in case you want to remove Blog as well, just go ahead and uninstall in the normal way but AFTER you have cleaned-up.

To remedy your situation, you need to delete the role 'blog-author'. 

[loopyloo]

I'm fully aware its a two step process. However I forgot about the cleanup and clicked uninstall. This is about usability and this is not usable. Considering the average user is not expected to look at the uninstall page to uninstall a module with a button called uninstall on it.
 

"Uninstall this module? After uninstalling, you may remove the modules files from the server if it is not in use by any other modules.

Uninstall

This will also uninstall other modules - MarkupBlog, BlogPublishDate"

Where does it say anything about Cleanup here?

I have already deleted the role blog-author and still get the same error. I tried deleting everything manually, twice and still get this error.

I have checked every table and field I can think of and cannot find blog-author-30.
 

 

[loopyloo]

There should be a link back to the Cleanup which is external from the 2nd step of the install process.

1. Uninstall.
2. Install.

3. See install failure due to not cleaning up.

4. Cannot reach Cleanup page as not installed. I would put the cleanup page with the install page so it can be accessed.

5. Manually delete everything, if you miss one thing, you have to start all over again.

Solution: Create a separate link to the cleanup page highlighting the SQL syntax to drop all relevant data.
 

• Cannot install Blog fields. Some field names already in use. These are: blog_body, blog_categories, blog_comments, blog_comments_view, blog_comments_max.

• A role called 'blog-author' already exists!

• Due to the above errors, the install wizard did not run. Make necessary changes and try again.

• SQLSTATE[23000]: Integrity constraint violation: 1062 Duplicate entry 'blog-author-30' for key 'name_parent_id'
  
  this is after manually uninstalling and deleting everything 4 times now.
  
  During the install it stops halfway through saying the field already exists from the >>>CURRENT<< install attempt.
  
  How could it? I checked the fields it references, deleted the field and ran it again. It now says a different field already exists.

[Joss]

I think with all complicated systems, and this is considerably more complicated that your average little textformatter, it is always worth reading all relevant documentation before doing anything drastic.

I speak as one who has often messed up because I didn't!

Like all those times in front of clients I ranted and raved because yet again, the huge tape machine in our studio was not working! 

Only for the maintenance man to come all the way up to the top floor just to turn the mains switch on.

Oops.

[loopyloo]

This is about usability , no rants and raves and it's a very simple solution.

With all complicated systems we code and focus on documentation and quirks later which stops adopt-ability. I code to make it fool-proof. It saves a lot of time in support etc later on.

[netcarver]

@loopyloo

As you are a coder you could always fork the blog repo, make improvements and submit a pull request back to kongondo's repo.

[kongondo]

Update: Blog version 2.3.3

In addition to the very clear instructions on how to uninstall Blog (README), I have added an even clearer textual reminder/warning in Blog's module configuration screen to first run the in-built Cleanup Utility before uninstalling the module. 

Committed to master...(including the new renderRelatedPosts()method discussed a couple of posts up.)

See next post about a utility to help when disaster strikes, aka, despite the very visible new warning text and despite the clear instructions you somehow find yourself with Blog components left in your hands having made the mistake of first uninstalling Blog and now you can't reinstall it without going through some very tedious manual cleanup....

[kongondo]

DISCLAIMER:

The Blog Module already provides an in-built Cleanup Utility that enables you to remove all its components. As per the instructions in the module's README, which must be thoroughly read before using the module (as instructed in the first post in this thread and in various other places), in case you wish to uninstall Blog, you FIRST have to run the Cleanup Utility whilst logged in as a Supersuser. Further, as of this writing, a clear warning text is now visible right above the uninstall button in Blog's module configuration screen reminding you of this fact. Failure to follow the correct uninstall routine means that you will not be able to reinstall Blog until you (often manually) delete all the leftover components (that the Cleanup Utility would have removed for you) - a tedious, frustrating and painful exercise. 

In case, for some reason, you did not adhere to the above instructions, I am providing in the link below code to help you automatically remove any Blog leftovers in order for you to reinstall the module (if you wish, of course) or in case you just want to clean up. 

On install, Blog stores the IDs of its main pages in its configuration settings. Uninstalling Blog means those settings are lost. Hence, if using this code, the only way to find Blog pages is by their templates which in some cases, may not be very foolproof. This and others issues are documented in the utility code linked to below. 

This code is provided as is, with no obligation on my part, without any warranty, implied or otherwise. In plain English; whilst I have thoroughly tested the code, you will be using it at your own risk for which I will bear no responsibility .

The code should ONLY be used in case you reversed the uninstall procedure; otherwise use the normal procedure (see README) to uninstall Blog.

Link: blogCleaner

Instructions:

1. Back up your database and template files
2. Log in as a Supersuser
3. Copy and paste the Cleaner code in the link above at the very top of a template file
4. Save the template file
5. On the frontend, visit a page that uses that template file
6. The Cleaner's screen will be loaded
7. Tick the checkbox to agree you 'know what you are doing, etc..'
8. Complete the questions about the type of Blog you had before the uninstall
9. Run the Cleaner
10. If no errors found a success message will be displayed
11. In your Admin, check that things went OK (and if need be  re-run the Cleaner)
12. Restore the template file in #3 to its previous state
13. Save the template file
14. Reinstall Blog (optional )

Screens

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

PS: I hope none of the above comes across as rude or forceful. I'll read this again in the morning just to be sure or in case someone PM's me, whichever is the sooner . I will then amend as appropriate.

[Peter Knight]

I have a series of blog posts on my blog.php.

It's just rendering a preview image, date, title and summary.

I want to control the order of the posts but neither 

sort=-date

or

sort=sort

is working when added to my two selectors.

         <!-- CENTRE COLUMN - MAIN -->               
          <div class="small-12 medium-9 large-9 columns ">
                <!-- START Nested Column containing featureimage and post-summary -->            
                    <?php $blogposts = $pages->find("template=blog-post"); foreach ($pages->find("template=blog-post,") as $b) {
                    echo "
					   <div class='row row-spacer'>
					     <div class='small-12 large-6 columns'><img src={$b->blog_images->first()->url} /></div>
					     <div class='small-12 large-6 columns'>
						 <div class='posts-date'>{$b->blog_date}</div>
						 <h3><a href='$b->url'>{$b->title}</a></h3>
						 {$b->blog_summary}</div>
					   </div>
					";
					} ?>
                <!-- END Nested Column containing featureimage and post-summary -->    
          </div>

[kongondo]

You can only sort by fields that exist in that template or internal properties (e.g., sort). There is no field called 'date' in the template 'blog-post'...unless you added it yourself? Otherwise, the following should work.

I don't know why you had two $pages->find()? Did you also add the field 'blog_summary'?

<!-- CENTRE COLUMN - MAIN -->               
<div class="small-12 medium-9 large-9 columns ">
    <!-- START Nested Column containing featureimage and post-summary -->            
        <?php $blogposts = $pages->find("template=blog-post, sort=-blog_date, sort=sort");

        foreach ($blogposts as $b) {
	        echo "
			   <div class='row row-spacer'>
			     <div class='small-12 large-6 columns'><img src={$b->blog_images->first()->url} /></div>
			     <div class='small-12 large-6 columns'>
				 <div class='posts-date'>{$b->blog_date}</div>
				 <h3><a href='$b->url'>{$b->title}</a></h3>
				 {$b->blog_summary}</div>
			   </div>
			";
		}
		?>
    <!-- END Nested Column containing featureimage and post-summary -->    
</div>

[Peter Knight]

@Kongondo

Thanks for the quick reply. I assumed the Date field was called date. As you point out, it's actually "blog_date". 

I've installed Somas Helper Field Links and this has made the field names more obvious.

  Quote

I don't know why you had two $pages->find()? 

I'm not sure either. I don't do this in my current projects and I wondered if it was a legacy piece of code. Clearly just an error though.

  Quote

Did you also add the field 'blog_summary'?

Yes, we use it for a tiny summary on the blog overview page. You probably have something like this native now but this is an older version of Blog Module I've yet to update.

Also, wanted to apologise for the abrupt request for help in the original post. My client is presenting this at 10AM this morning and informed me 30 mins prior to the meeting that they needed the posts in a particular order. The order had been fine for the past few days. Anyway, thanks again. 

[creativejay]

Hi Kongondo. I attempted to comment on a blog post and was redirected to [root]/#CommentForm which just booted me back to the home page.

My blog-post.php template file contains only the following code regarding blog comments:

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

and

echo $page->blog_comments->render();

echo $page->blog_comments->renderForm(); 

$numComments = $page->blog_comments->count();

Here's the markup that the site outputs for the form.

<div id='CommentForm' class='CommentForm_new'>
<h3>Post Comment</h3>
<form id='CommentForm_form' action='./#CommentForm' method='post'>
	<p class='CommentForm_cite'>
		<label for='CommentForm_cite'>Your Name</label>
		<input type='text' name='cite' class='required' required='required' id='CommentForm_cite' value='' maxlength='128' />
	</p>
	<p class='CommentForm_email'>
		<label for='CommentForm_email'>Your E-Mail</label>
		<input type='text' name='email' class='required email' required='required' id='CommentForm_email' value='' maxlength='255' />
	</p>
	<p class='CommentForm_text'>
		<label for='CommentForm_text'>Comments</label>
		<textarea name='text' class='required' required='required' id='CommentForm_text' rows='5' cols='50'></textarea>
	</p>
	<p class='CommentForm_submit'>
		<button type='submit' name='CommentForm_submit' id='CommentForm_submit' value='1'>Submit</button>
		<input type='hidden' name='page_id' value='1449' />
	</p>
</form>
</div><!--/CommentForm-->

Without changing the module I'm not sure how to fix this. I checked the Settings in Blog Admin but nothing seems to control the form directly.

[kongondo]

Not sure what funkiness is going on there. Have a look at the demo blog-post.php. All you need to render both comments and the form is MarkupBlog's method renderComments() (form will only be displayed if the page uses the template blog-post).

$blog = $modules->get("MarkupBlog");
echo $blog->renderComments($page->blog_comments);

Edited February 2, 2015 by kongondo

[creativejay]

Thanks Kongondo. I replaced my code with yours, but the result of attempting to post a comment is the same.

[kongondo]

Aah, I think I know what is happening....It is not directly related to Blog but the settings of your comments field. Edit the field blog_comments. Go to..

Admin > Setup > Fields > Edit Field: blog_comments. Go to the Details tab. In the second row on that settings page, under Redirect after comment post?, I think you have that checkbox checked. Read the info there and decide whether you want to have it redirect or not. 

[creativejay]

I hadn't checked all those settings before! Redirect after Comment was not checked, and playing with the settings there had no effect. The comment is not posted and the user ends up on the site front page (/#CommentForm).