Jump to content

Recommended Posts

In that case there is something else wrong with your setup. It is difficult to tell without seeing/testing on the actual site Any other changes you have made to your template files? Some other modules possibly interfering? What about testing comments + form apart outside of the Blog (non-blog pages)?

Share this post


Link to post
Share on other sites

My template files are very different from the default. ;) I haven't touched the module itself, though. I'd be happy to give you access to my admin if you have the time to take a look. I can post any templates here that you think may be causing the issues.

Form Builder works outside of the blog pages. I don't have comments for non-blog pages, though.

Share this post


Link to post
Share on other sites

Yeah, comments on a non-blog page aren't working, either. Same result. I'll move my questioning to that fieldtype discussion. Thanks kongondo!

Share this post


Link to post
Share on other sites

I got another little issue. If someone uses the quickpost function and fills out quickpost_body all line breaks will be removed.

I don't think that is it necessary to use a rich text area here but maybe you can wrap it in a simple nl2br function?

        //@todo - SHOULD THIS BE A RICH TEXT AREA?
-       $p->blog_body = $this->sanitizer->textarea($this->input->post->quickpost_body);
+       $p->blog_body = nl2br($this->sanitizer->textarea($this->input->post->quickpost_body
  • Like 1

Share this post


Link to post
Share on other sites

Yeah, this has been brought up before but wasn't really sure how to deal with it. Thanks for reminding me :-).

For now, I have decided to convert and store the line breaks in 'quickpost' to paragraphs (instead of <br>) since I believe that is the intended action by the user when they use a line break in 'quickpost' to space out their text. Besides, that is what CKEditor is going to do when the full post is edited. Using nl2br will result in lots of <br> all of which CKEditor will wrap in one paragraph. But thanks to your idea, I am now using a pre_replace to do the job. It works fine.

Committed to dev for now.

  • Like 1

Share this post


Link to post
Share on other sites

Thanks a lot for this quick fix   :)

I checked out the dev branch, reset my deployment script and everything works fine (and all post authors are happy now  ;) ).

  • Like 1

Share this post


Link to post
Share on other sites

For the Categories / Tags and other Page-type fields, the parent of those pages gives blog-author the right to Add Children, and the field has "Allow new pages to be created from field" checked. Anything else I need to check for? I'm able to create new pages as a superuser but my blog-author role users get a little achtung triangle in the AsmSelect field when they type, and nothing is saved. In Select cases, there's no option to add another for blog-author roles. What I glean from this is that there's another permissions setting somewhere, other than the per-template "Add Children" setting for blog-author.

I already started this over once in a new install and ran into the same comments issue before I got very far (managed to reverse the problem by restoring the default templates, so the problem is either with my call to the comments form, or some other module that I call in my template files).

Edited by creativejay

Share this post


Link to post
Share on other sites

Have you given the role 'blog-author' the right site-level permissions? In ProcessWire access is controlled at both site- and template- levels. 

Admin > Access > Roles > blog-author. The permission page-edit is needed...

Share this post


Link to post
Share on other sites

Yes, the blog-author role has page-edit permissions.

There are sub-permissions from page-edit that I do not have checked off:

page-delete

page-edit-recent

page-lister

page-lock

page-move

page-sort

page-template

Share this post


Link to post
Share on other sites

Then the problem is in your blog-tag and blog-category templates. You have two choices:

  1. Set up access to the pages using these templates, i.e. an individual 'tag' and 'category' respectively by setting up access in their respective parents' templates, i.e. 'blog-tags' and 'blog-categories' AND making sure the two child templates 'blog-tag' and 'blog-category' have No checked for their respective 'manage view and edit access for pages using this template?' setting. In that case, pages using 'blog-tag' and 'blog-category' will inherit their parents' access. Then, in 'blog-tags' and 'blog-categories' you will need to check for the role 'blog-author' View Pages, Edit Pages, Create Pages and Add Children. Alternatively:
  2. Set up access on the child templates themselves, i.e. in 'blog-tag' and 'blog-category' templates. In this case, in their parents' templates, 'blog-tags' and 'blog-categories' you would only need to add the access Add Children. In 'blog-tag' and 'blog-category' you would need to grant access to View Pages, Edit Pages and Create Pages

If the above don't work, there could be some access inheritance issues going on...Access issues are of course controlled by ProcessWire itself and not Blog :-)

Share this post


Link to post
Share on other sites

Thanks Kongondo, that confirms what I'd been doing was correct.

I got clarification from the blog-author role user that spotted the problem with creating new pages from fields: she had never been able to do this.  On a hunch I disabled PagesCreatedEdit and sure enough that allowed the user to create their new tags, categories, etc. Unfortunately now blog-author can edit blog posts other than their own created posts. I may make a custom Module based on PagesCreatedEdit to try and make a special exception to the rule for certain templates.

Share this post


Link to post
Share on other sites
Update: Blog Version 2.3.4

Blog now preserves all line breaks as paragraphs for posts created via ProcessBlog's quickpost, thanks to idea by @justb3a

Share this post


Link to post
Share on other sites

Hey Kongondo,

I noticed that when I first installed Blog, probably about 4 months ago, the module was called in my templates as


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

And now $blogOut seems to be $blog in your more recent documentation. Is there something in the modules themselves that should compel me to go back to the default templates as a new starting point? (Yes, I'm still struggling with comments and I have narrowed it down to being caused by my template file code...)

Share this post


Link to post
Share on other sites

Nope..you can call it anything you want (as long as it is a valid PHP variable name) - $b, $myBlog, $thoughts, $blahBlah.... :D

RE comments, maybe paste your template code in pastebin and I'll have a look if I can find some time....

  • Like 1

Share this post


Link to post
Share on other sites

Hi,

I am just getting started with PW. I've successfully installed but not yet confirgured the ProcessBlog module and would like to know before I delve further whether or not a single instance of the module can be used to deliver multiple blogs. What I have in mind for the website I am currently working on is both a separate News section and a separate Testimonials section.

Is it actually necessary to completely split the two sections/blogs in terms of the backend? If not, how should I go about setting this up? Can categories be set up to split the data for News and Testimonials? Effectively both pages could be built around the same underlying data structure, for example:

$post-date-time             ( - would like the date|time to appear as yyyymmdd - hh:mm:ss, though)
                                         - do I actually need this field or can this data be retrieved from a built-in PW source??

$post-title

$post-summary

$post-author

$post-category              ( - needed or not?)

In addition, what are the advantages / disadvantages of the different blog styles? Purely from the path name perspective it appears that Blog style 3: /mysite/posts/example-post/ might be the most appropriate.

Otherwise, would Joss's Simple News System be a better place to start?

Any guidance would be greatly appreciated. :)

Edited by kongondo
Moved to Blog's support forum

Share this post


Link to post
Share on other sites

@ridgedale,

Welcome to PW and the forums.

Multiple Blogs:

This issue has been raised a couple of times but I haven't yet resolved how to best implement such a feature:

 
 

Is it actually necessary to completely split the two sections/blogs in terms of the backend? If not, how should I go about setting this up? Can categories be set up to split the data for News and Testimonials?

At the moment it is not possible to have such a split. I am wondering whether this can be achieved by simply adding some field on a post's template to assign it to a particular field...hmm...
 
$post-date-time
Change your date's input/output format in the field 'blog_date'
 
$post-summary
You can have a post summary by using renderPosts($posts, true) - see the Blog documentation. Alternatively, you can create your own summary field and use that.
 
Blog Styles

In addition, what are the advantages / disadvantages of the different blog styles?

Purely user preferences...

Share this post


Link to post
Share on other sites

@kondongo

I am sorry for the delay in replying, I thought I'd raised a new topic (Evidently not! :huh: ) and therefore wasn't looking in the right place for any replies.
Thank you for your very speedy reply and the links.

I had an issue with links between the pages which I appear now to have resolved using:

<a href="<?php echo $config->urls->root; ?>about"</a>

All of those below returned blank pages:

<a href="<?php echo $config->urls->templates; ?>about"</a>
<a href="/about"</a>
<a href="./about"</a>

I'll read through the links you have provided and see how I get on.

In the meantime I've tried working through the Simple News System guide so far without success.
I'm not sure if this is an issue related to the installation path of this instance of PW (in this instance while the site is under development: http://localhost:8888/rcl_pw252/ ) or the fact that I changed the name of the templates, fields and pages.
I'm pretty certain I've updated the news.php, news-index.php and inc/news-fnc.inc files have been updated correctly accordingly, but I still get blank pages being returned which might suggest that the inc/news-fnc.inc file needs to include paths in at least some instances as well.
Any thoughts would be appreciated.

Thanks again. :)
 

Share this post


Link to post
Share on other sites

Hey kongondo, I finally fixed my comments! As usual, it was something completely innocuous: I had a base href tag in my header that was redirecting the #comments to the root URL of the site installation. Deleted that line, and suddenly my comments worked. :frantics:

I was taking a very methodical approach to figuring this out (finally sitting down tonight after weeks of not having time to focus), thankfully my method led to the answer in five steps.

Now that I can finally put in some example comments to play with:

1) If I wanted to notify the admin listed in the blog_comments/Details tab, PLUS the author of the post that received a comment, what would you suggest? I don't want to add every author to the list of those who receive comments as a global setting.

2) I have a custom admin tab that is the admin home of all authors. I'd like to identify any pending comments they should review and output a message such as "You have # comments pending review. Please visit the Comments Manager."  Would you suggest I start with the code from  "public function findComments($selector)" in MarkupBlog.module (line 541 in the latest release version)?

Edited by creativejay

Share this post


Link to post
Share on other sites

Hi,

Can anyone tell me whats wrong with my code here please. I am trying to blog page with images and small text. Small texts are ok but images showing only one. Any help, would be greatly appreciated.

<?php
//CALL THE MODULE - MarkupBlog
$blog = $modules->get("MarkupBlog");
$limit = 10;
$post = $pages->get('template=blog-post, sort=blog_date');
$image = $post->blog_images->first();
?>

<div class="jumbotron">
    <h3><?php echo $page->title ?></h3>
</div>
<!-- /.Header_End -->
<div class="main-content container">
    <div class="row">

        <!-- Blog -->
        <div class="blog-list">
            <div class="row">
                <div class="col-md-6 post-list">

                    <div class="ih-item square effect9 right_to_left"><a href="#">

                            <div class="img img-responsive"><img src="<?php echo $image->url; ?>" alt="img"></div>
                            <div class="info">
                                <div class="info-back">
                                    <h3></h3>
                                    <p></p>
                                </div>

                            </div></a>

                    </div>

                </div>
                <div class="col-md-6 post-list">
                    <?php
                    echo $blog->renderPosts("limit={$limit}", true);
                    ?>
                </div>

            </div><!-- row_end-->
        </div>
    </div>
</div> 

Share this post


Link to post
Share on other sites

@Qurus
 

Hi,
Can anyone tell me whats wrong with my code here please. I am trying to blog page with images and small text. Small texts are ok but images showing only one. Any help, would be greatly appreciated.

<?php
$image = $post->blog_images->first();
?>

 
On that line you are only calling one image....specifically the first one. If you want to output several images you would have to loop through them. Have a read here. something like

$out = '';
foreach($post->blog_images as $img) {

$out .= '<img src="' . $img->url . '" alt="img">';

}
//then output $out later on down...within your <div class="img".......

@creativejay...get back to you later.....

  • Like 1

Share this post


Link to post
Share on other sites

1) If I wanted to notify the admin listed in the blog_comments/Details tab, PLUS the author of the post that received a comment, what would you suggest? I don't want to add every author to the list of those who receive comments as a global setting.

2) I have a custom admin tab that is the admin home of all authors. I'd like to identify any pending comments they should review and output a message such as "You have # comments pending review. Please visit the Comments Manager."  Would you suggest I start with the code from  "public function findComments($selector)" in MarkupBlog.module (line 541 in the latest release version)?

Sorry for the delay.

#1: Am not sure how to do that. It is really a Comments Module question. Maybe Ryan could help there

#2: Yes  :-)

Seem you really have some cool setup there. Would like to see a screen if possible.

Cheers,

/k

Share this post


Link to post
Share on other sites

Thanks! I'm trying to make the site as fun as possible (it's a non-income-generating pet project), to make it emotionally rewarding for the authors that have volunteered to provide content.

I'm attaching a screen shot of the post-login home page for an author (non-superuser). Fair warning, the color scheme may hurt the eyes. I'm going for quirky here.

The challenge area is the 'ticket' system I was referring to.

post-1266-0-31405400-1425998308_thumb.pn

  • Like 2

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 tcnet
      PageViewStatistic for ProcessWire is a module to log page visits of the CMS. The records including some basic information like IP-address, browser, operating system, requested page and originate page. Please note that this module doesn't claim to be the best or most accurate.
      Advantages
      One of the biggest advantage is that this module doesn't require any external service like Google Analytics or similar. You don't have to modify your templates either. There is also no Javascript or image required.
      Disadvantages
      There is only one disadvantage. This module doesn't record visits if the browser loads the page from its browser cache. To prevent the browser from loading the page from its cache, add the following meta tags to the header of your page:
      <meta http-equiv="Cache-Control" content="no-cache, no-store, must-revalidate" /> <meta http-equiv="Pragma" content="no-cache" /> <meta http-equiv="Expires" content="0" /> How to use
      The records can be accessed via the Setup-menu of the CMS backend. The first dropdown control changes the view mode.

      Detailed records
      View mode "Detailed records" shows all visits of the selected day individually with IP-address, browser, operating system, requested page and originate page. Click the update button to see new added records.

      Cached visitor records
      View modes other than "Detailed records" are cached visitor counts which will be collected on a daily basis from the detailed records. This procedure ensures a faster display even with a large number of data records. Another advantage is that the detailed records can be deleted while the cache remains. The cache can be updated manually or automatically in a specified time period. Multiple visits from the same IP address on the same day are counted as a single visitor.

      Upgrade from older versions
      Cached visitor counts is new in version 1.0.8. If you just upgraded from an older version you might expire a delay or even an error 500 if you display cached visitor counts. The reason for this is that the cache has to be created from the records. This can take longer if your database contains many records. Sometimes it might hit the maximally execution time. Don't worry about that and keep reloading the page until the cache is completely created.
      Special Feature
      PageViewStatistic for ProcessWire can record the time a visitor viewed the page. This feature is deactivated by default. To activate open the module configuration page and activate "Record view time". If activated you will find a new column "S." in the records which means the time of view in seconds. With every page request, a Javascript code is inserted directly after the <body> tag. Every time the visitor switches to another tab or closes the tab, this script reports the number of seconds the tab was visible. The initial page request is recorded only as a hyphen (-).

      Settings
      You can access the module settings by clicking the Configuration button at the bottom of the records page. The settings page is also available in the menu: Modules->Configure->ProcessPageViewStat.
      IP2Location
      This module uses the IP2Location database from: http://www.ip2location.com. This database is required to obtain the country from the IP address. IP2Location updates this database at the begin of every month. The settings of ProcessPageViewStat offers the ability to automatically download the database monthly. Please note, that automatically download will not work if your webspace doesn't allow allow_url_fopen.
      Dragscroll
      This module uses DragScroll. A JavaScript available from: http://github.com/asvd/dragscroll. Dragscroll adds the ability in view mode "Day" to drag the records horizontally with the mouse pointer.
      parseUserAgentStringClass
      This module uses the PHP class parseUserAgentStringClass available from: http://www.toms-world.org/blog/parseuseragentstring/. This class is required to filter out the browser type and operating system from the server request.
    • By Mike Rockett
      TextformatterTypographer
      A ProcessWire wrapper for the awesome PHP Typography class, originally authored by KINGdesk LLC and enhanced by Peter Putzer in wp-Typography. Like Smartypants, it supercharges text fields with enhanced typography and typesetting, such as smart quotations, hyphenation in 59 languages, ellipses, copyright-, trade-, and service-marks, math symbols, and more.
      It's based on the PHP-Typography library found over at wp-Typography, which is more frequently updated and feature rich that its original by KINGdesk LLC.
      The module itself is fully configurable. I haven't done extensive testing, but there is nothing complex about this, and so I only envisage a typographical bug here and there, if any.
    • 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
×
×
  • Create New...