Jump to content

Recommended Posts

1) Dev Install. I also made a backup overnight just in case  :rolleyes:

2) Local Machine. Head scratcher this one!

3) No code alteration. 

4) Yes the admin account. The only account I normally use 

5) See below

6) Do you mean reinstalling the module or physically copying files across to the Blog Module directory?

I've tried to reinstall but PW says I already have the latest version.

http://imgur.com/qQPbZXQ

Just another thought, perhaps have the Cleanup Code available as a separate module could be good too?

Share this post


Link to post
Share on other sites

That image tells me you haven't finished installing the Blog module. It is step-2 of the installation. I don't know how you got the Blog pages then since you seem not to have finished installing blog. There's is a button 'Run Install Wizard' on that screen that you need to press to fully install Blog (see image below). When done, you should see a screen like the one I posted earlier, i.e. the Blog Dashboard. You don't see the cleanup menu because you haven't finished installing Blog. What happens you click on the 'Run Install Wizard' button? If this is local install, then it is just easier to start over. If you wanna go that route, I'll guide you with the cleanup...

post-894-0-34452000-1411146244_thumb.png
Edited by kongondo

Share this post


Link to post
Share on other sites

Yes, I don't know how I got myself into this predicament.
I did press the run install wizard and everything indicated that the installation went fine.

Run Install Wizard won't run now because of all the existing fields, templates etc & the installation rolls back.

I'm happy to start again.

The reason I need to start again (besides this)  is that I can't seem to add Authors under the Authors page and wasn't sure I had to do it via the Blog Module. 

I will keep an eye out on logs etc in case it happens again ... touch wood it doesn't.
Having a bad day and hoping this is the start of my change of fortunes

Share this post


Link to post
Share on other sites

Authors are not added via the authors' page. They are normal ProcessWire users with the role 'blog-author'.
 
Try the following to cleanup blog manually:

  • Copy all the code in BlogCleanup.php to one of your template files, at the very top. Save
  • Find and replace 'private function' to 'public function' in the code you just copied
  • Find public function cleanUpPages() and add the following lines to it, at the very top of the function. Save
//Get the module config data
$this->data = wire('modules')->getModuleConfigData(get_parent_class($this));

$this->blogStyle = $this->data['blogStyle'];//selected blog style (1-4)
$this->commentsUse = $this->data['commentsUse'];//commenting feature on/off
$this->templateFilesInstall = $this->data['templateFilesInstall'];
  • Add the following code to your template file, somewhere after the last } of the BlogCleanup class you copied to this template file
$bc = new BlogCleanup();
echo $bc->cleanUpPages();
  • Visit a page that uses the template file you added the BlogCleanup class to. Blog Cleanup will run but you will get lots of PHP notices. Just ignore them. You will also have to manually delete your template files (normally it would be done for you but that needs code alteration in our manual cleanup).
  • Restore you template file to the state it was before you added the BlogCleanup class. Save

You should be able to start afresh then. I am afraid I don't have any more time today to invest in this. Hope it works out.

Edited by kongondo

Share this post


Link to post
Share on other sites

Hi Kongondo,

Thanks for the instructions, Kongondo!

Much appreciated!

Unfortunately, it didn't work too well for me as it didn't clean up everything (as you mentioned) and I ended up deleting entries off the CMS as the error messages dictated.

I finally managed to get it install (I think!) with 1 error message that I'm not sure is an error, as the comments table actually is created by the installation.

I've also remembered why I got into this predicament.

The very first installation I did failed because my xdebug.max_nesting_level was set to 100 and not something higher & the installation process reached that limit. 
I was meant to come back to it, but never had the time.

After I did the cleanup & increased this number to 300, I got new error messages which I worked through. which I fixed eventually.

I will also try and post the SQL I used in seperate post.

http://imgur.com/V6OExBn
 


Rollback instructions. Use at your own risk.

1) Export your site or DB first before you do anything else. Backup! Backup! Backup!

2) Run the following script

start transaction;
select * from templates where name like '%blog%';
delete from templates where name like '%blog%';
select * from templates where name like '%blog%';
 
 
select * from fields where name like '%blog%';
delete from fields where name like 'blog%';
select * from fields where name like 'blog%';
 
select * from pages where name like '%blog%';
delete from pages where name like 'blog%';
select * from pages where name like 'blog%';
 
select * from fieldgroups where name like '%blog%'
select * from fieldgroups_fields where fieldgroups_id in (
select id from fieldgroups where name like '%blog%'
)
delete from fieldgroups_fields where fieldgroups_id in (
select id from fieldgroups where name like '%blog%'
)
delete from fieldgroups where name like '%blog%'
rollback;
 
If the Rollback attempt looks fine, run a Commit version of it.

Share this post


Link to post
Share on other sites

Aah...wish you'd mentioned that xdebug issue :-). It's bitten somebody else here before. Anyway, you got there in the end. The comments field sql error can be safely ignored. I mentioned it to Ryan a while ago but he didn't seem to be able to replicate it. It has nothing to do with Blog per se, but the comments module which ships with PW...

You rollback instructions (even with the disclaimer) seem quite dangerous and I wouldn't recommend any one to use them. You are using LIKE to search. That will match other things that are not 'blog' but 'sound' like blog...Instead, use the cleanup facility in Blog :-)

Edited by kongondo

Share this post


Link to post
Share on other sites

Yes I agree with it being dangerous ... but I was in a desperate corner and I was willing to take the risk.

As for the script itself and '%Blog%' being dangerous, I do agree but that's why I also had Select statements in there for the user to check before they delete.

Hopefully no one else will have to go through what I did :)

That XDebug issue, I only recently discovered what the cause & its outreaching effect was.

Also I first installed the blog quite a while back, long before XDebug became a big issue and i was searching around for answers.
 

I definitely will have a "Cleanup" celebration later this evening with some well earned bevvies!

Share this post


Link to post
Share on other sites

Hi,

I have a question regarding logging in the Processwire Module as a Blog Author.

I created a user that is a member of the blog-authors group.

When I login to the Processwire admin page using the user's credentials, this is all I see is this.

http://imgur.com/o5hbrWG

Had a look, and it has the following error log entry.

DATE/TIME USER URL TEXT 8 seconds ago
 

2015-10-18 14:05:33 admin /processwire/page/list/?id=id&render=render&am…

SQLSTATE[HY000]: General error: could not call class constructor [pageClass=Page, template=]

The URL Link above is :

http://localhost:8888/processwire/page/list/?id=id&render=render&start=start〈=lang&open=open&mode=mode

Logging in as Admin, there are no issues with the blog.

I can do everything including entering blog posts.

There are no error log entries for Admin/Blog Module.

FYI, I have set couple of child pages of the Blog as hidden. Could this be the cause?

Share this post


Link to post
Share on other sites

Ok I worked out that perhaps the blog-author users have no permissions to see any pages.

So I'm looking at the Blog Template and it has an option to let me choose permissions. 

However, I can't seem to click on checkboxes that enables it.

http://imgur.com/K8JFQDM

Any ideas?

Share this post


Link to post
Share on other sites

This is actually ProcessWire territory and not a Blog one. :-).

I'd suggest that you search and have a read in the forums and docs how ProcessWire implements access controls. As you've figured out, access in ProcessWire is controlled at two levels; the high level (when editing a 'role') and the low level (at the template level).. Also have a good read of the info in the 'role' edit screen. This 'homework' will help you beyond Blog...:-)

  • Like 2

Share this post


Link to post
Share on other sites

Ok thanks for the Homework :)

Feel like I'm back in school again.

I've read the docs and some forum articles as you suggested.

Didn't realise you had to allocate Add-Children permissions as well on the Blog-Posts to be able to add a new Blog-Post.

(Create Page & Edit Page permissions was not enough)

Was there a reason no permissions are set by default during the initial installation?

Seems to me a Blog-Author role implies it should be able to create & edit Blog Posts by default.

Share this post


Link to post
Share on other sites

Was there a reason no permissions are set by default during the initial installation?

Seems to me a Blog-Author role implies it should be able to create & edit Blog Posts by default.

Yes. Doing things the ProcessWire way....we make no assumptions (aka total freedom for end-user to implement as they wish). Some stuff, e.g. the role and demo files, Blog offers as a courtesy to get you started

Share this post


Link to post
Share on other sites

Yes. Doing things the ProcessWire way....we make no assumptions (aka total freedom for end-user to implement as they wish). Some stuff, e.g. the role and demo files, Blog offers as a courtesy to get you started

Aaah the Processwire way. Had a feeling you might say something similar.

I'm slowly getting accustomed to it nonetheless :)

Share this post


Link to post
Share on other sites

Hi Kongondo,

I've noticed there's a Quick Post section in the Posts Menu in the Blog Dashboard.

But it's not showing a field I added to the Blog Post Template.

I'm guessing I have to modify some module code to get it showing (& saving)?

Do you know which modules I have to look at?

Or is there another way that I've overlooked?

Share this post


Link to post
Share on other sites

It's not meant to show any other fields. For that, you need to edit your post as page as usual.

Share this post


Link to post
Share on other sites

I assume you meant traversing the Page Tree and entering a Blog Post as a page?

I think for a CMS administrator or a Developer, that is a fine workaround.

But unfortunately we're trying to convince bloggers to come write for our site and that particular UX in Processwire is not a great selling point for us IMHO.

I think the Blog Panel is actually a much better UX for a non technical person to enter blog entries into.

Just a shame that  adding a single custom field to it as not as straight forward.

Share this post


Link to post
Share on other sites

I assume you meant traversing the Page Tree and entering a Blog Post as a page?

I think for a CMS administrator or a Developer, that is a fine workaround.

But unfortunately we're trying to convince bloggers to come write for our site and that particular UX in Processwire is not a great selling point for us IMHO.

I think the Blog Panel is actually a much better UX for a non technical person to enter blog entries into.

Just a shame that  adding a single custom field to it as not as straight forward.

use this in combination with that and you have a strong "selling point" and/or alternative admin UX for batch editing even this module could be a solution for the "holder page" like /pw-root/posts/... to use ;)

The Blog panel serv also all posts in the postspage and all posts have a edit link on there titles....so hide the quickpost row simple via CSS...

Also make use of the simple and easy "Add New" Button and/or bookmarks so the user don't have to navigate trough the pagetree...there are many shortcuts and UI improvments possible with PW - but like everything else the choice to use them in your setup is on you!

regards mr-fan

  • Like 3

Share this post


Link to post
Share on other sites

Thanks for the valuable advice, Mr-Fan!

The custom admin module and the Batch Child Editor looks really useful. Especially the Batch Child Editor.

Just looked at some PW showcase websites featuring ListerPro and definitely on the shopping list

  • Like 1

Share this post


Link to post
Share on other sites

@FrancisChung, best way to remove manually is to literally uninstall module and remove the pages, so everything under blog in the page list should be deleted, including the blog page itself.  Then move into deleting the fields, then delete templates.  As in delete, I mean, delete through ProcessWire.  Once you have done this, empty trash on the page list.  Then go ahead and delete the templates from your templates directory via SSH or FTP. 

If you have tons of posts under blog, then use batch editor to remove them all at once. 

Just curious, 

Why are you removing this module?

Share this post


Link to post
Share on other sites

@quickjeff...his Blog install got messed up by an x-debug limitation so he needed to reinstall. He was caught between a rock and a hard place and couldn't use the 'cleanup feature' since Blog didn't finish installing due to the x-debug thing.

Edited by kongondo
  • Like 1

Share this post


Link to post
Share on other sites

@Kongondo -  do we know who the host is?

In this case its not the module but the install. 

Share this post


Link to post
Share on other sites

@kongondo - Since it was local best bet is to remove all the files or add the files again, perhaps something was missed.

Share this post


Link to post
Share on other sites

Update: Blog Version 2.3.5 (dev branch only for now)

Changes

  1. Fixed issue of slow loading dashboards on sites with lots of posts.
  2. Added some missing translation strings, thanks @mr-fan.
  3. Decluttered modal window, thanks @mr-fan.
  4. Some code optimisations.

I don't think there are any other pending issues. Apologies it took so long to get to this update; we got there in the end :-)

Edited by kongondo
  • Like 2

Share this post


Link to post
Share on other sites

@Metadope,

In my testing, I never managed to replicate the issue you reported here. I know it's been a while but wondering if you managed to resolve your issue?

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