Jump to content

Recommended Posts

would it be possible to incorporate an existing news section of a site to the blog profile?

  • Like 1

Share this post


Link to post
Share on other sites

So i'm a newbie in PW and make my first steps into deep.

so i've tried to translate this great addon to german....so far so good.
 
But the Top Menu Bar in Backend ( Dashboard Posts Categories Tags Authors Settings )

seems to cant get translated...so my question:

did i not get it or are there some strings hard coded in this module?

EDIT: worked the first one out....PW is so easy to learn great stuff... ;)

done a pull request: https://github.com/kongondo/Blog/pulls

Great Admintool

Featurerequests could be like described above:

- publish from/until feature (so you've get a eventcal option with dashboard, too without much effort or have a second addon)

- in Dashboard -> Overview could the Archive view linked to a row below with lists the posts in the clicked month?

- a blog addon that i used in another CMS has widget for "older + newer" topics - it's like "recent posts" but little different (maybe i find the time to contribute this by my self if i was more familiar with PW)

- what's about META tags like description and keywords?

i've seen some "automatic" functions for create them but let them overwrite from the author...

function makemetadescription ($thestring) {

$the_description = stripslashes($thestring);
$the_description = str_replace('"', ' ', $the_description);
$the_description = str_replace("'", ' ', $the_description);
$the_description = str_replace('\'', ' ', $the_description);
if (strlen($the_description) > 160) {
if(preg_match('/.{0,160}(?:[.!?:,])/su', $the_description, $match)) { $the_description = $match[0]; } //thanks to thorn

if (strlen($the_description) > 160) {
$pos = strpos($the_description, " ", 120);
if ($pos > 0) {$the_description = substr($the_description, 0, $pos); }	
}
}
//$the_description = ' '.$the_description;
$the_description = trim(str_replace(' ',' ',$the_description));

return (' '.$the_description);
}

function makemetakeywords ($thestring ) {

$the_keywords = $thestring;
if (strlen($the_keywords) > 100) {
if(preg_match('/.{0,100}(?:[.!?:,])/su', $the_keywords, $match)) { $the_keywords = $match[0]; } //thanks to thorn
if (strlen($the_keywords) > 100) {
$pos = strpos($the_keywords, " ", 100);
if ($pos > 0) {$the_keywords = substr($the_keywords, 0, $pos); }	
}
}	
$bad = array(
'\'', /* / */ '"', /* " */	'<', /* < */	'>', /* > */
'{', /* { */	'}', /* } */	'[', /* [ */	']', /* ] */	'`', /* ` */
'!', /* ! */	'@', /* @ */	'#', /* # */	'$', /* $ */	'%', /* % */
'^', /* ^ */	'&', /* & */	'*', /* * */	'(', /* ( */	')', /* ) */
'=', /* = */	'+', /* + */	'|', /* | */	'/', /* / */	'\\', /* \ */
';', /* ; */	':', /* : */	' ', /* */	'.', /* . */	'?' /* ? */
);
$the_keywords = str_replace($bad, ',', $the_keywords);
$the_keywords = str_replace(',,,',',',$the_keywords);
$the_keywords = str_replace(',,',',',$the_keywords);

return (' '.$the_keywords);
}
  • Like 1

Share this post


Link to post
Share on other sites

Some more Tweaking....

- tags are burned words in SEO maybe buzzwords or something is better use actually?

- tag pages should be noindex,follow per default? (Since newbee where is the best PW practise to setup such things)

Share this post


Link to post
Share on other sites

Kongondo,

Regarding blog_date field. I get the feeling it is designed to be the date/time that the blog post is published, but from what I can see it gets set when the post is first created and doesn't automatically change after that. I might be misunderstanding your use of the field, but I would like to see it change automatically when the post is published and not change after that - maybe even disable user editing of it?

I know we often draft up several posts at a time and publish them later. I don't think we should have to manually adjust this field when publishing the post.

Another thought for you - have you considered integrating this module:

http://modules.processwire.com/modules/schedule-pages/

or the functionality from it into the blog posts tab? This would make WP users feel at home. Thanks for considering.

blog_date field

You are right. It should be about the post publish date. I don't think this will be difficult to implement - I'll just steal and modify the code here by SiNNuT and Soma :D. I'd still like to leave a manual override (i.e. not disable user editing of it); I envisage cases where a post is published 'by mistake' and has to be recalled for later publication. 

Scheduled Pages

I'll have a think about this one. I can see the potential.

Thanks for your ideas!

  • Like 1

Share this post


Link to post
Share on other sites

Currently it looks like the excerpt length is hardcoded to 450 characters - perhaps adding an option for people to set this themselves would be a good idea? In the meantime, for anyone that wants to change this, find the line

Thanks for filing this in GitHub. I currently have this working on my local install. Added a 'blog_excerpt' integer field to the 'blog' template. Will also enable editing via the 'Settings' tab in ProcessBlog. Due to the nature of this module, for existing installs (i.e. if you've already installed ProcessBlog) you will have to manually create the field; The module will not attempt to modify existing fields; the risk of corrupting/loosing your data means it's not worth it :-). I'll post a notice here once I have updated the module, thanks.

Share this post


Link to post
Share on other sites

would it be possible to incorporate an existing news section of a site to the blog profile?

fenton,

Good question. It's something I've been discussing with some people. Currently, the only way to achieve this is to clone the module and modify it (typically paths and selectors) to read your news section pages (i.e. the fields). Obviously, that is not ideal or for everyone. However, Blog is meant for, er blogging. So, another solution is needed. The current idea is to create a separate (but similar) skeleton module that is highly configurable and adaptable to different needs such a news site, etc. At the moment, this is still an idea. There is no ETA yet :-)

Cheers.

  • Like 1

Share this post


Link to post
Share on other sites

So i'm a newbie in PW and make my first steps into deep.

so i've tried to translate this great addon to german....so far so good.

But the Top Menu Bar in Backend ( Dashboard Posts Categories Tags Authors Settings )

seems to cant get translated...so my question:

did i not get it or are there some strings hard coded in this module?

EDIT: worked the first one out....PW is so easy to learn great stuff... ;)

done a pull request: https://github.com/kongondo/Blog/pulls

Great Admintool

Featurerequests could be like described above:

- publish from/until feature (so you've get a eventcal option with dashboard, too without much effort or have a second addon)

- in Dashboard -> Overview could the Archive view linked to a row below with lists the posts in the clicked month?

- a blog addon that i used in another CMS has widget for "older + newer" topics - it's like "recent posts" but little different (maybe i find the time to contribute this by my self if i was more familiar with PW)

- what's about META tags like description and keywords?

i've seen some "automatic" functions for create them but let them overwrite from the author...

mr-fan

First, welcome to PW and the forums! Happy to hear Blog is of some use to you. Thank you for your suggestions

Translatable Strings

Apologies for my oversight! Thanks for the pull request. I'll have a look and update.

Publish from/until feature

See my response to @Adrian above. I'll have to think a bit more about this although it is a good idea I think. I just have to think about how to best implement it.

Archive - linked to row below with list of month's posts

Not sure about this one. The Posts tab already shows the lists of posts sorted by date

Meta tags, etc.

Not sure I follow what you mean?

Tags vs buzzwords

I don't think buzzwords will work :-)

noindex, nofollow

The best way to find stuff on these forums/PW site is to search using Google. E.g. noindex nofollow site:processwire.com

See this example: https://processwire.com/talk/topic/3928-meta-robots-on-individual-pages/?p=38483

Thanks!

Share this post


Link to post
Share on other sites

Apologies. version 1.0.0 of module was installed at /site/templates/Blog/ ...that should be /site/templates/ProcessBlog/ If updating the module within the PW Admin, this will write to this latter path... You will need to manually remove the former folder :-)

Share this post


Link to post
Share on other sites

Thanks for the Link for the robots - it's a thing that i missed until now - and it seems to implement easy like most everything in PW ;)

i will work further - thanks for this great addon.

PW is almost very peferct to my need or rather beeing so flexible to fit it.

Best Regards mr-fan

Share this post


Link to post
Share on other sites

Awesome work! Now, what if i needed to have 10 separate blogs like this on the same site?  >:D

  • Like 1

Share this post


Link to post
Share on other sites

.......Now, what if i needed to have 10 separate blogs like this on the same site?  >:D

Seriously? If yes, out of the box, no. But with some trickery, you can have MarkupBlog output posts from only a particular author, assuming each author has their own blog. I am just thinking out loud here. If this is a feature request, I'd like to have more details but also hear what others think :-)

Glad you like the module. :D

  • Like 2

Share this post


Link to post
Share on other sites

Seriously?

Yes, seriously  :( unfortunately I am working on just such a site right now. It's for a business that has 10 separate locations (pseudo-franchises, which are more or less independent) and they will all need to have their own separate blogs with their own URLs and their own tags, categories and archives. 

So far I've used a method where all the blogs have different templates in PW which all point to the same template file (which is based on Ryan's blog profile) but I've made the template file dynamic so the names of all the fields are built at run-time based on a naming convention. For example: tags-location1-name, tags-location2-name... etc. instead of just having 1 tags field. And all those suffixes are stored in a special hidden field in the root page of each location.

Don't mean to derail this thread, just wanted to point out a situation where more than 1 individual blog is needed and how much work it can take to set up something like that. 

Again, big thanks for your work, it's going to save me a lot of time on many projects!

Share this post


Link to post
Share on other sites

......just wanted to point out a situation where more than 1 individual blog is needed and how much work it can take to set up something like that. 

Yeah, something to think about for the future... :-)

Share this post


Link to post
Share on other sites

Update: Blog version 1.1

Read below before updating.

For new installs, proceed as normal

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

Changelog

1. Added new widget 'Post Author' - @adrian idea, thanks.

- This widget allows you to add a post's author's biography with each post. You can add it before or after a post (or wherever you wish). See example in updated 'blog-post.php'

example: 

$blog = $modules->get('MarkupBlog');
echo $blog->postAuthor();

- The widget can be enabled/disabled in the 'Settings' Tab of ProcessBlog. It is enabled by default

- Updated the CSS to style the widget

Screen

post-894-0-20359800-1401445817_thumb.png

2. Made 'posts truncate length' configurable - @looeee idea, thanks.

- This is for when you want to render a 'post summary' - e.g. as seen on /blog/posts/.

- Was previously hard-coded to 450. Default is now 450 where no value is specified

- Can be configured either on the page /blog/posts/ or 'Settings' Tab of ProcessBlog

UPGRADING

As I have said previously and repeat here (just in case you missed it :D) a module of this kind must not be altering your data if you've already installed it or where there are potential conflicts. 

Therefore, to upgrade, some manual input is required. Once we hit a lock-down on new features, then this requirement will fizzle out...

A. Author Widget

1. This comes with a new template without a template file. 

- Create a template called 'blog-widget-basic'

- Give it a tag 'blog' and a label 'Blog Widget: Basic' //just for consistency with other blog templates

- Add the field 'blog_summary' save. Then within the template (i.e. click on the upward arrow of the field), change the description to 'Widget Description' in the modal that opens up. Save...

- Still on the edit template view, under the 'Family' tab, specify 'No' under 'May pages using this template have children?' and 'Yes' to 'Can this template be used for new pages?' Save...

- Copy over the updated blog.css to /site/templates/css/ (this assumes you haven't made any custom changes to this file!!!)

2. Post Author page

- Under /blog/widgets/ create a new page called 'Post Author' and assign it the the above template ('blog-widget-basic')

- In the 'Widget Description' field enter a description, e.g. 'Renders Post's author biography.' Save...

The Author Widget should then automatically appear under 'Settings' in the Widgets section in ProcessBlog

B. Post Excerpt Length

1. Add Field to Template

- In the template 'blog-posts', add the field 'blog_quantity'. Save. Change the field's description to 'Posts truncate length'. Save

C. Update Blog to version 1.1

In PW, now update the module to version 1.1. This will copy over the new module files (ProcessBlog.module and MarkupBlog.module) and their related files.

Note: installer will not run again! So, don't worry :D

All done; now go write a post about how cool ProcessWire is  :P  O0

  • Like 5

Share this post


Link to post
Share on other sites

Hey kongondo - great improvements.

I have another suggestion for a widget for you :)

On the main posts page, I like having a thumbnail of the first image to the left of the summary text. Of course you could use the first image from the images field, but I think it would be more appropriate to use the first image embedded in the post - domdocument or even a regex does the trick nicely. You could maybe even have a "feature image" field which could be used for this purpose, or perhaps enable tags on the images field and have people enter "feature_thumb" or something like that in the tag field for the image they want to use as the thumbnail - this might be the simplest and most flexible approach and will also require no duplication of images.

Share this post


Link to post
Share on other sites

....I have another suggestion for a widget for you :)

On the main posts page, I like having a thumbnail of the first image to the left of the summary text. Of course you could use the first image from the images field, but I think it would be more appropriate to use the first image embedded in the post - domdocument or even a regex does the trick nicely. You could maybe even have a "feature image" field which could be used for this purpose, or perhaps enable tags on the images field and have people enter "feature_thumb" or something like that in the tag field for the image they want to use as the thumbnail - this might be the simplest and most flexible approach and will also require no duplication of images.

OK, I'll wait for a pull request from you  :P  ;) .....

I'll have a think...but I'll work on the auto-publish-date feature first...

Edit:

Show me an example post please, thanks.

Edited by kongondo

Share this post


Link to post
Share on other sites

Comments on/off?

Been thinking about a new feature. Ability to turn on/off comments both on a per post basis and on a Blog-wide basis. So, if a post has comments turned off, the user gets the usual 'Comments not allowed for this post' or something similar. Additionally, maybe also a feature to turn-off submitting of new comments on a post when approved comments hit a certain number, say '100'. What do you guys think?

Need to think a bit more about how best to implement this... :-)

  • Like 4

Share this post


Link to post
Share on other sites
Show me an example post please, thanks.

This should give you an idea of what I mean:

post-985-0-65264000-1401463010_thumb.png

On another note, I like being able to only display the Recent Posts when viewing a single post. I don't see much value in having it on the blog home page because the recent posts are there already.

As for comments - all those options sound great!

Share this post


Link to post
Share on other sites

Blogwide there is only one option -> ignore blogpagesettings and overwrite this settings but not change it...if one switch back to comments=on the blogpagesettings are already there? Don't know this is to do in the PWWay...

Share this post


Link to post
Share on other sites

Blogwide there is only one option -> ignore blogpagesettings and overwrite this settings but not change it...if one switch back to comments=on the blogpagesettings are already there? Don't know this is to do in the PWWay...

Exactly. so, the logic, in order of ascending precedence (i.e. 3 > 1, etc.) could probably go like this:

1. Comments are ON by default.

2. On each 'post' page (/blog/posts/my-post/), will include a checkbox: 'check to disable comments for this post'. This will ignore #1

3. On some settings page or on the 'posts' page (/blog/posts/) have a checkbox or similar that says: 'disable comments on all posts'. Ignore #1 & #2

So, #3 is 'greatest' and will ignore #1 and #2 but will NOT change their settings; checked boxes (#2) will remain checked and unchecked ones (#1) will remain unchecked but their 'directions' will be superseded by #3 .

#################################  EDIT #################################

Oops warped thinking on precedence above!!! It should be the other way round! See edits below..

So, the logic, in order of ascending precedence (i.e. 3 > 1, etc.) could probably go like this:

1. Comments are enabled by default everywhere.

2. On the 'comments' page (/blog/comments/) have a select that says: 'disable comments on all posts/disable new comments on all posts'. Ignore #1 but respect individual post's settings (#3)

3. On each 'post' page (/blog/posts/my-post/), will include a select: 'disable comments on this post/disable new comments on this post/always enable comments on this post'. This will ignore #1 & 2. This is like a get() in ProcessWire: it is explicit and ignores 'hidden' status.  

So, #3 (individual post setting) is 'greatest' and will ignore #1 and #2.

#################################  END EDIT #################################

Btw, you will notice very soon that there's very little 'do this the PW way' - in many cases, there is no PW way :D The system is so versatile yet powerful you will be amazed... :-)

  • Like 3

Share this post


Link to post
Share on other sites

i will try to learn fast....;) i'm already amazed and i only see the surface! i've to less time to dive into all the sourcecode...

Share this post


Link to post
Share on other sites

Had an oops moment in my post #47 above; edited it :D (sort of a note to self; feel free to ignore  ;)  :P )

Share this post


Link to post
Share on other sites

Fantastic work, kongondo. Your module is much needed for those of us who don't want to spend a lot of time stripping out the markup on Ryan's (equally awesome) blog module.

One question: I notice that blog posts have this url: www.domain/blog/posts/my-post-here

Have you considered any approach which might remove "/posts/" from that URL? My existing blog doesn't have the extra segment and I'd love to keep it that way, if possible.

I've also been thinking I could remove it via htaccess.

  • Like 2

Share this post


Link to post
Share on other sites

..........One question: I notice that blog posts have this url: www.domain/blog/posts/my-post-here

Have you considered any approach which might remove "/posts/" from that URL? My existing blog doesn't have the extra segment and I'd love to keep it that way, if possible.

I've also been thinking I could remove it via htaccess.

Hi FuturShoc. Glad you like the module.

I thought about this a lot, even with the /site/blog/.... URL, where others would prefer /site/my-awesome-post/...but decided to leave it to the user (for now at least...), if they so wish, to manipulate the URL segments... :-)

UPDATE:

Feature now available in Blog version 2

Edited by kongondo

Share this post


Link to post
Share on other sites

Join the conversation

You can post now and register later. If you have an account, sign in now to post with your account.

Guest
Reply to this topic...

×   Pasted as rich text.   Paste as plain text instead

  Only 75 emoji are allowed.

×   Your link has been automatically embedded.   Display as a link instead

×   Your previous content has been restored.   Clear editor

×   You cannot paste images directly. Upload or insert images from URL.


  • Recently Browsing   0 members

    No registered users viewing this page.

  • Similar Content

    • By ukyo
      FieldtypeFontIconPicker
      v.0.1.6
      Fix FieldtypeFontIconPicker sanitizeValue() v.0.1.5
      Added uikit icon select support (required AdminThemeUikit), because uikit icons not working standalone. v.0.1.4 :
      Fix issue FontIconPicker inside repeater v.0.1.3 :
      FontAwesome updated to 4.7.0 v.0.1.2 :
      Little Corrections Some works about icon pickers inside repeater via ajax load v.0.1.1 :
      FontAwesome updated to 4.6.3 v.0.1.0 :
      Custom CSS file url support Added hook method ___beforeRender(), you can check hook example for usage Added multiple icons library use option Added Ionicons Library Now module using cdn for load icon fonts v.0.0.9 inside dev branch
      Added hook method ___beforeRender(), you can check hook example for usage Added multiple icons library use option Added Ionicons Library Now module using cdn for load icon fonts v.0.0.8
      FontAwesome 4.5 update, Improvements and Performance updates Important ! After update module check your input settings, because i changed input attribute names (This will only effect input options, like theme, category). Changed loading icon method from input:hidden to select>optgroup>option, added module js file for load and correct icon picker container many changes…. v.0.0.7
      FontAwesome updated to 4.4.0 v.0.0.6
      Missed... array compatibility for usage, from [$foo, $bar] to array($foo, $bar) v.0.0.5
      Fix for oldest pw versions (Assets file loding scripts moved to inputfieldfonticonpicker module) v.0.0.4
      Array compatibility for usage, from [$foo, $bar] to array($foo, $bar) v.0.0.3
      Small z-index problem solved v.0.0.2
      MarkupFontIconPicker added v.0.0.1
      Start Point FieldtypeFontIconPicker
      Supported Icon Libraries
      FontAwesome 4.7.0 Uikit 3.0.0 IonicIcons 2.0.1 Cahangelog
      NOTE: Module store data without prefix, you need to add "prefix" when you want to show your icon on front-end, because some of front-end frameworks using font-awesome with different "prefix".
      Example :
      if($my-icon-field) echo "<i class='my-prefix-{$my-icon-field}' />"; Hook Before Render Example This example using /site/templates/admin.php file for hook
      wire()->addHook('InputfieldFontIconPicker::beforeRender', function($event) { if(!$event->return) return; // Get Input Name (For specified input hook, if you want apply all InputfieldFontIconPicker remove inputName check) $inputName = ""; if(isset($event->object->attributes['name'])) $inputName = $event->object->attributes['name']; // Get Input Name (For specified input hook, if you want apply all InputfieldFontIconPicker remove inputName check) if($inputName == 'icon_picker') { /** * Load your custom icons function file * Your array need to be same format with Icons/FontAwesome.php or Icons/Ionicons.php * Also you can pass directly an array */ wireIncludeFile('MyCustomIconFile'); // Set icons as $icons variable $icons = MyCustomIconsArray(); // Set your options $return = array( 'attributes' => array( 'category' => '', 'theme' => 'fip-grey', 'empty-icon' => 1, 'empty-icon-value' => '', 'icons-per-page' => 20, 'has-search' => 1 ), 'icons' => $icons ); // Return the event $event->return = $return; } $event->return; }); MarkupFontIconPicker Usage
      // MarkupFontIconPicker::render(YourIconField=string, Options=array) echo MarkupFontIconPicker::render($page->YourIconField, [ 'prefix' => 'uk-icon-', // Icon class prefix, if you have different prefix, default is : "fa fa-" 'tag' => 'span', // Icon tag default is : "i" 'class' => 'fa-lg', // If you have extra cutom classes, for example : icons sizes, Array or Sting value 'style' => 'your custom styles if you have' // Array or String Value ]); Screenshots - InputfieldFontIconPicker input settings



      Screenshots - InputfieldFontIconPicker page edit views


       
      Github Repo
    • By Xonox
      After some years with a website working perfectly, Page Clone started to display some strange behaviour:
      1. When cloning some pages, it takes forever. The waiting icon is displayed but the page never appears. Only after I refresh the tree page, the new page appears:

      2. The other thing is that some pages can't be copied. The pages have the same templates but the users are able to copy some and other don't. It gives this error:

      (the URL is .../page/clone/?id=76376&login=1)
      Does someone have a clue why this is happening. I can't find any real difference between the pages that I'm trying to copy.
      One more thing: If the user is a super user, he's able to copy every page without problems.
      I think both errors might be related. Thanks!
    • By Gadgetto
      Status update links (inside this thread) for SnipWire development will be always posted here:
      2019-11-15 2019-10-18 2019-08-08 2019-06-15 2019-06-02 2019-05-25 If you are interested, you can test the current state of development:
      https://github.com/gadgetto/SnipWire
      Please note that the software is not yet intended for use in a production system (alpha version).
      If you like, you can also submit feature requests and suggestions for improvement. I also accept pull requests.
      ---- INITIAL POST FROM 2019-05-25 ----
      I wanted to let you know that I am currently working on a new ProcessWire module that fully integrates the Snipcart Shopping Cart System into ProcessWire. (this is a customer project, so I had to postpone the development of my other module GroupMailer).
      The new module SnipWire offers full integration of the Snipcart Shopping Cart System into ProcessWire.
      Here are some highlights:
      simple setup with (optional) pre-installed templates, product fields, sample products (quasi a complete shop system to get started immediately) store dashboard with all data from the snipcart system (no change to the snipcart dashboard itself required) Integrated REST API for controlling and querying snipcart data webhooks to trigger events from Snipcart (new order, new customer, etc.) multi currency support self-defined/configurable tax rates etc. Development is already well advanced and I plan to release the module in the next 2-3 months.
      I'm not sure yet if this will be a "Pro" module or if it will be made available for free.
      I would be grateful for suggestions and hints!
      (please have a look at the screenshots to get an idea what I'm talking about)
       




    • By Robin S
      I have had this module sitting in a 95% complete state for a while now and have finally made the push to get it out there. Thanks to @teppo for his Hanna Code Helper module which I referred to and borrowed from during development.
      http://modules.processwire.com/modules/hanna-code-dialog/
      https://github.com/Toutouwai/HannaCodeDialog
      HannaCodeDialog
      Provides a number of enhancements for working with Hanna Code tags in CKEditor. The main enhancement is that Hanna tags in a CKEditor field may be double-clicked to edit their attributes using core ProcessWire inputfields in a modal dialog.
      Requires the Hanna Code module and >= ProcessWire v3.0.0.
      Installation
      Install the HannaCodeDialog module using any of the normal methods.
      For any CKEditor field where you want the "Insert Hanna tag" dropdown menu to appear in the CKEditor toolbar, visit the field settings and add "HannaDropdown" to the "CKEditor Toolbar" settings field.
      Module configuration
      Visit the module configuration screen to set any of the following:
      Exclude prefix: Hanna tags named with this prefix will not appear in the CKEditor toolbar dropdown menu for Hanna tag insertion. Exclude Hanna tags: Hanna tags selected here will not appear in the CKEditor toolbar dropdown menu for Hanna tag insertion. Background colour of tag widgets: you can customise the background colour used for Hanna tags in CKEditor if you like. Dialog width: in pixels Dialog height: in pixels Features
      Insert tag from toolbar dropdown menu
      Place the cursor in the CKEditor window where you want to insert your Hanna tag, then select the tag from the "Insert Hanna tag" dropdown.

      Advanced: if you want to control which tags appear in the dropdown on particular pages or templates you can hook HannaCodeDialog::getDropdownTags. See the forum support thread for examples .
      Edit tag attributes in modal dialog
      Insert a tag using the dropdown or double-click an existing tag in the CKEditor window to edit the tag attributes in a modal dialog.

      Tags are widgets
      Hanna tags that have been inserted in a CKEditor window are "widgets" - they have a background colour for easy identification, are protected from accidental editing, and can be moved within the text by drag-and-drop.

      Options for tag attributes may be defined
      You can define options for a tag attribute so that editors must choose an option rather than type text. This is useful for when only certain strings are valid for an attribute and also has the benefit of avoiding typos.
      Add a new attribute for the Hanna tag, named the same as the existing attribute you want to add options for, followed by "__options". The options themselves are defined as a string, using a pipe character as a delimiter between options. Example for an existing attribute named "vegetables":
      vegetables__options=Spinach|Pumpkin|Celery|Tomato|Brussels Sprout|Potato You can define a default for an attribute as normal. Use a pipe delimiter if defining multiple options as the default, for example:
      vegetables=Tomato|Potato Dynamic options
      Besides defining static options as above, you can use one Hanna tag to dynamically generate options for another. For instance, you could create a Hanna tag that generates options based on images that have been uploaded to the page, or the titles of children of the page.
      Your Hanna tag that generates the options should echo a string of options delimited by pipe characters (i.e. the same format as a static options string).
      You will probably want to name the Hanna tag that generates the options so that it starts with an underscore (or whatever prefix you have configured as the "exclude" prefix in the module config), to avoid it appearing as an insertable tag in the HannaCodeDialog dropdown menu.
      Example for an existing attribute named "image":
      image__options=[[_images_on_page]] And the code for the _images_on_page tag:
      <?php $image_names = array(); $image_fields = $page->fields->find('type=FieldtypeImage')->explode('name'); foreach($image_fields as $image_field) { $image_names = array_unique( array_merge($image_names, $page->$image_field->explode('name') ) ); } echo implode('|', $image_names); Choice of inputfield for attribute
      You can choose the inputfield that is used for an attribute in the dialog.
      For text attributes the supported inputfields are text (this is the default inputfield for text attributes so it isn't necessary to specify it if you want it) and textarea. Note: any manual line breaks inside a textarea are removed because these will break the CKEditor tag widget.
      Inputfields that support the selection of a single option are select (this is the default inputfield for attributes with options so it isn't necessary to specify it if you want it) and radios.
      Inputfields that support the selection of multiple options are selectmultiple, asmselect and checkboxes.
      You can also specify a checkbox inputfield - this is not for attributes with defined options but will limit an attribute to an integer value of 1 or 0.
      The names of the inputfield types are case-insensitive.
      Example for an existing attribute named "vegetables":
      vegetables__type=asmselect Descriptions and notes for inputfields
      You can add a description or notes to an attribute and these will be displayed in the dialog.
      Example for an existing attribute named "vegetables":
      vegetables__description=Please select vegetables for your soup. vegetables__notes=Pumpkin and celery is a delicious combination. Notes
      When creating or editing a Hanna tag you can view a basic cheatsheet outlining the HannaCodeDialog features relating to attributes below the "Attributes" config inputfield.
      Advanced
      Define or manipulate options in a hook
      You can hook HannaCodeDialog::prepareOptions to define or manipulate options for a Hanna tag attribute. Your Hanna tag must include a someattribute__options attribute in order for the hook to fire. The prepareOptions method receives the following arguments that can be used in your hook:
      options_string Any existing string of options you have set for the attribute attribute_name The name of the attribute the options are for tag_name The name of the Hanna tag page The page being edited If you hook after HannaCodeDialog::prepareOptions then your hook should set $event->return to an array of option values, or an associative array in the form of $value => $label.
      Build entire dialog form in a hook
      You can hook after HannaCodeDialog::buildForm to add inputfields to the dialog form. You can define options for the inputfields when you add them. Using a hook like this can be useful if you prefer to configure inputfield type/options/descriptions/notes in your IDE rather than as extra attributes in the Hanna tag settings. It's also useful if you want to use inputfield settings such as showIf.
      When you add the inputfields you must set both the name and the id of the inputfield to match the attribute name.
      You only need to set an inputfield value in the hook if you want to force the value - otherwise the current values from the tag are automatically applied.
      To use this hook you only have to define the essential attributes (the "fields" for the tag) in the Hanna Code settings and then all the other inputfield settings can be set in the hook.
      Example buildForm() hook
      The Hanna Code attributes defined for tag "meal" (a default value is defined for "vegetables"):
      vegetables=Carrot meat cooking_style comments The hook code in /site/ready.php:
      $wire->addHookAfter('HannaCodeDialog::buildForm', function(HookEvent $event) { // The Hanna tag that is being opened in the dialog $tag_name = $event->arguments(0); // Other arguments if you need them /* @var Page $edited_page */ $edited_page = $event->arguments(1); // The page open in Page Edit $current_attributes = $event->arguments(2); // The current attribute values $default_attributes = $event->arguments(3); // The default attribute values // The form rendered in the dialog /* @var InputfieldForm $form */ $form = $event->return; if($tag_name === 'meal') { $modules = $event->wire('modules'); /* @var InputfieldCheckboxes $f */ $f = $modules->InputfieldCheckboxes; $f->name = 'vegetables'; // Set name to match attribute $f->id = 'vegetables'; // Set id to match attribute $f->label = 'Vegetables'; $f->description = 'Please select some vegetables.'; $f->notes = "If you don't eat your vegetables you can't have any pudding."; $f->addOptions(['Carrot', 'Cabbage', 'Celery'], false); $form->add($f); /* @var InputfieldRadios $f */ $f = $modules->InputfieldRadios; $f->name = 'meat'; $f->id = 'meat'; $f->label = 'Meat'; $f->addOptions(['Pork', 'Beef', 'Chicken', 'Lamb'], false); $form->add($f); /* @var InputfieldSelect $f */ $f = $modules->InputfieldSelect; $f->name = 'cooking_style'; $f->id = 'cooking_style'; $f->label = 'How would you like it cooked?'; $f->addOptions(['Fried', 'Boiled', 'Baked'], false); $form->add($f); /* @var InputfieldText $f */ $f = $modules->InputfieldText; $f->name = 'comments'; $f->id = 'comments'; $f->label = 'Comments for the chef'; $f->showIf = 'cooking_style=Fried'; $form->add($f); } }); Troubleshooting
      HannaCodeDialog includes and automatically loads the third-party CKEditor plugins Line Utilities and Widget. If you have added these plugins to your CKEditor field already for some purpose and experience problems with HannaCodeDialog try deactivating those plugins from the CKEditor field settings.
    • 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.4.2
      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
       
       
×
×
  • Create New...