MadeMyDay

Module: PageTableExtended

Recommended Posts

PageTableExtended

 

Download here: http://modules.processwire.com/modules/fieldtype-page-table-extended/

 

Extends the Processwire PageTable field for rendering table row layouts. This is great for editors, because they actually see at a glance what the table rows consist of.

What it does

 

Turns the Processwire Fieldtype "Page Table" from this:

git1.jpg

 

into something like this (sorting capabilities of course still functional):

 

git2.jpg

See it in action:

Requirements

  • FieldtypePageTable installed (part of the core since Processwire 2.4.10.)
  • Templates used for PageTable need a file associated (otherwise nothing gets rendered)
  • This render method is meant for sites where the PageTable templates only render part of the layout, not complete websites. But you also can define what will be rendered (see below).

Options

git3.jpg

Render Layout instead of table rows

Check this for seeing the rows rendered. You can easily turn off the complete functionality by unchecking this.

Path to Stylesheet

Since the parts are unstyled by default, it is a good idea to define styles for them. All rendered templates are encapsulated in a div with the class "renderedLayout" so you can style them with:

div.renderedLayout h2{
color: green;
}

The path is to be set relative to your templates' folder.

Reset Admin CSS

Since the parts are rendered inside the Admin, common styles of the Admin Interface apply also to your layout parts. This is not a bad thing, because especially text styles are well integrated in your admin's theme. But if you like to override the admin styles in your table rows completely (more or less), just check this box. Don't forget to define a custom CSS then!

Advanced

 

Since this module is meant for parts of your layout you already have defined for your frontend templates, it is a good idea to use a preprocessor like Stylus, Sass or Less for building the custom CSS file. Just outsource your layout part definitions in an extra file, compile that in a separete CSS file and use this as custom CSS for this module. Since your CSS is should be built in a modular way, this works pretty well ;-) Will write a tutorial with a use case once finished testing.

 

Notes:

 

Github: https://github.com/MadeMyDay/PageTableExtended

 

If you want to get rid of the unnecessary step for entering a title before editing the page, just set the "autoformat" value as suggested in the PageTable settings. If you don't want to use a title field at all, see this post from Soma

 

Will put it in the module repository once finished testing. Please test it and give feedback. I haven't used GitHub for a long time, please check if everything is in place and if this will work with the modules manager and the new core module installer once added to the repository. Have fun :)

 

Module is in the repository now: http://modules.processwire.com/modules/fieldtype-page-table-extended/

 

Please use GitHub for instructions, I made some additions there.

  • Like 33

Share this post


Link to post
Share on other sites

Awesome! - only one suggestion - it would be great to have text fields editable inline, with ajax save - might be beyond the scope of what you want, but I think it would be cool :)

Share this post


Link to post
Share on other sites

Awesome! - only one suggestion - it would be great to have text fields editable inline, with ajax save - might be beyond the scope of what you want, but I think it would be cool :)

I am a bit ambivalent regarding such a feature. Of course it would be nice, but also would add a lot of overhead to this specific module. If there would be an existing solution for that (for the frontend), it would be easy to integrate it as well in this module (including necessary js and css files should be enough), because the layouts are rendered as in the frontend.

  • Like 1

Share this post


Link to post
Share on other sites

I guess I am mixing purposes a bit here - your goal was to style the output exactly as it will appear on the frontend, but I guess I am looking more for replicating the ease of editing that repeaters have. Maybe I'll make a different extension for PageTable that works more that way. Maybe not worry about the ajax saving and just use the page save to save each of PageTable components. I'll mull over it for a bit.

  • Like 2

Share this post


Link to post
Share on other sites

I totally agree. I was waiting for a configurable repeater (with different templates to choose from) for ages. Now PageTable has this feature, so I went with this ;) But hey, never say never. Question is... When do you want to save the changes? Autosave? No good idea as long there are no draft versions. So this is getting complicated. Either you provide a save button on each row (easy to implement, but hard to understand for editors) or you save the entries on page save (easier to understand but harder to implement). You then would have to monitor the changed fields, look for their page, save the fields on each page... well.

Share this post


Link to post
Share on other sites

Hi Marc, you know - I don't have any experience with PageTable field.

I've installed the module and added the templates. Everything works fine for me. The Elements are there, I can add content und frontend shows everything.

In your folder are two Modules.

PageTable Renderer (Renders PageTable entries in admin) and PageTable render (Adds render functionality for PageTable fields). First one is installed. The second one requires InputFieldPageTable which I can't find. I thing thats the reason, why I have no settings.

The rendering doesn't work for me yet and I've a little understanding problem, how I got this working for me…

Share this post


Link to post
Share on other sites

@yesjoar

You need to install the dev version of 2.4 instead of the stable one. PageTable is a new Fieldtype which is only available with the dev version.

Share this post


Link to post
Share on other sites

@yesjoar

You need to install the dev version of 2.4 instead of the stable one. PageTable is a new Fieldtype which is only available with the dev version.

I have the latest dev version. PageTable is installed and everything works fine for me. Like I said. ;)

But the rendering in the page itselfs doesn't work for me. Also I can't install the second rendering module.

Share this post


Link to post
Share on other sites

Have you installed the new fieldtype FieldtypePageTableExtended? And then created/changed the field with "PageTableExtended" ? It's a new field.

Share this post


Link to post
Share on other sites

Hi Yesjoar,

PageTable Renderer (Renders PageTable entries in admin) and PageTable render (Adds render functionality for PageTable fields). First one is installed. The second one requires InputFieldPageTable which I can't find. I thing thats the reason, why I have no settings.

Okay, I pushed an update to GitHub. The dependencies of the modules were not clear and the titles misleading. Please try to override the modules with the new ones.

Share this post


Link to post
Share on other sites
Hi Tobaco,
 
my setup is always the same. Doesn't matter if I use PageTable or not. Here it goes (simplified):
 
/templates
- basic-page.php
- home.php
- /tpl 
   - main.php
   - mainnav.php
   - subnav.php
   - footer.php
 
 
The tpl/main.php is the overall template like:
 
<?php
include('tpl/mainnav.php');
include('tpl/subnav.php');
include('tpl/slider.php');
?>
<!DOCTYPE html>
<html class="no-js">
    <head>
        <meta charset="utf-8">
        <meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1">
        <title><?= $page->title ?></title>
        <!--- styles and scripts -->
    </head>
    <body class='<?= $bodyclass ?>'>
        <header>
            <div class='wrap'>
                <a href="/"><img src='/site/templates/img/logo.png' class='logo' alt="Logo"></a>
                <nav class='main'>
                    <?= $mainnav ?>
                </nav>
            </div>
        </header>
        <?= $slider ?>
        <?= $subnav ?>
<section class="content">
            <div class="wrap group">
                <h1 class='v2 hide'><span><?= $page->title ?></span></h1>
                <?= $content ?>
            </div>
        </section>
        <footer>
            <div class="group">
                <?php include ('tpl/footer.php'); ?>
            </div>
        </footer> 
        <script src="/site/templates/dist/all.min.js"></script>
    </body>
</html>

basic-page template looks like this (every template renders the content and then includes the main template):

<?php
/**
 * basic page template
 *
 */
$bodyclass='inner';

$content = $page->body;

include('tpl/main.php');
 
With PageTable the structure looks like this:
 
/templates
- basic-page.php
- home.php
- part_text.php
- part_columns.php
- part_gallery.php
- /tpl 
   - main.php
   - mainnav.php
   - subnav.php
   - footer.php

The part_* templates are templates only for PageTable. part_columns.php could look like this:

<?php
$headline1 = "";
$headline2 = "";
if(!$page->checkbox1) $headline1 = "<h2>{$page->title}</h2>";
if(!$page->checkbox2) $headline2 = "<h2>{$page->text1}</h2>";

// Output

echo "
<div class='pageTableSection {$page->template->name}'>
    <div class='inner'>
        <div class='col one-half'>
                {$headline1}
                {$page->body}
         </div>
        <div class='col one-half'>
            {$headline2}
            {$page->textarea1}
        </div>
    </div>
</div>

";

And the basic page template gets enhanced by ("layout" being the PageTableExtend field):

<?php 

/**
 * basic page template
 * including PageTable layout parts
 */
$bodyclass='inner';

$content = "{$page->body}";

if(count($page->layout)>0){
     foreach($page->layout as $l){
         $content .= $l->render();
     }
}

include('tpl/main.php');
 
That way, the layout parts are easily renderable in the Admin with PageTableExtended.
 
While writing this, I want to point to another feature of the module. If rendered by PageTableExtended, the template gets an option 'pageTableExtended' which you can use in your part template:
 
// Output

echo "
<div class='pageTableSection {$page->template->name}'>
    <div class='inner'>
        <div class='col one-half'>
                {$headline1}
                {$page->body}
         </div>
        <div class='col one-half'>
            {$headline2}
            {$page->textarea1}
        </div>
    </div>
</div>

";

if(!$options['pageTableExtended']){ 
    // we are not in the Admin, so we include our social media buttons which we only need in our frontend
    include('social/socialmediabuttons.php);
}

Hope that helps.

  • Like 12

Share this post


Link to post
Share on other sites
Since your CSS should be built in a modular way, this works pretty well ;-)

Ha! that *wink* should be bigger. :P

BTW, this is so awesome!

  • Like 2

Share this post


Link to post
Share on other sites

Awesome stuff! This is one of the features i was always missing in pw. Great Job MadeMyDay.

  • Like 2

Share this post


Link to post
Share on other sites

I hadn't actually realised you could specify more than one template for a PageTable field! Did that get snuck in after one of the early versions or am I just blind in general? :)

It actually makes an "article" system a lot easier to build where an editing user might want to dump in some text, then an image, then some more text exactly as you have, but with your module it's one step better as it's pretty much WYSIWIG.

Inline edits would be nice as folks have said, but this is still really, really useful!

  • Like 1

Share this post


Link to post
Share on other sites
I hadn't actually realised you could specify more than one template for a PageTable field! Did that get snuck in after one of the early versions or am I just blind in general?
 
Wasn't there from the beginning. But as owzim posted this: https://processwire.com/talk/topic/4189-flexibility-in-page-design/page-4#entry63924 I knew, this is the key to my always wanted flexible layout parts :)
 
It actually makes an "article" system a lot easier to build where an editing user might want to dump in some text, then an image, then some more text exactly as you have, but with your module it's one step better as it's pretty much WYSIWIG.
 
exactly.
 
Inline edits would be nice as folks have said, but this is still really, really useful!
 

Of course they would be. But as I said: If there would be a solution for the frontend, it could easily be applied to this module. I think developing a solution only for this module would be out of scope.

Will try to include Apeisa's Fredi. If that works without hazzle, any inline solution should work.

Share this post


Link to post
Share on other sites

So behind the times :(

@MadeMyDay - just submitted a pull request to fix some freaky things I was experiencing either due to a template delegation situation or some freaky admin code I've done but I think it could affect certain people in certain scenarios so best to be safe.

And because I'm nice I made sure it was all still compatible with your instructions afterwards ;)

  • Like 1

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 BitPoet
      As threatened in the Pub sub forum in the "What are you currently building?" thread, I've toyed around with Collabora CODE and built file editing capabilities for office documents (Libre-/OpenOffice formats and MS Office as well as a few really old file types) into a PW module.
      If you are running OwnCloud or NextCloud, you'll perhaps be familiar with the Collabora app for this purpose.
      LoolEditor
      Edit office files directly in ProcessWire
      Edit your docx, odt, pptx, xlsx or whatever office files you have stored in your file fields directly from ProcessWire's page editor. Upload, click the edit icon, make your changes and save. Can be enabled per field, even in template context.
      Currently supports opening and saving of office documents. Locking functionality is in development.
      See the README on GitHub for installation instructions. You should be reasonably experienced with configuring HTTPS and running docker images to get things set up quickly.
      Pull requests are welcome!
      Here is a short demonstration:

    • By Robin S
      An Images field allows you to:
      Rename images by clicking the filename in the edit panel or in list view. Replace images, keeping metadata and filename (when possible) by dropping a new image on the thumbnail in the edit panel. Introduced here. But neither of these things is possible in File fields, which prompted this module. The way that files are renamed or replaced in this module is not as slick as in the Images field but it gets the job done. The most time-consuming part was dealing with the UI differences of the core admin themes. @tpr, gives me even more respect for the work that must go into AdminOnSteroids.
      Most of the code to support the rename/replace features is already present in InputfieldFile - there is just no UI for it currently. So hopefully that means these features will be offered in the core soon and this module can become obsolete.
       
      Files Rename Replace
      Allows files to be renamed or replaced in Page Edit.

      Usage
      Install the Files Rename Replace module.
      If you want to limit the module to certain roles only, select the roles in the module config. If no roles are selected then any role may rename/replace files.
      In Page Edit, click "Rename/Replace" for a file...
      Rename
      Use the text input to edit the existing name (excluding file extension).
      Replace
      Use the "Replace with" select to choose a replacement file from the same field. On page save the file will be replaced with the file you selected. Metadata (description, tags) will be retained, and the filename also if the file extensions are the same.
      Tip: newly uploaded files will appear in the "Replace with" select after the page has been saved.
       
      https://github.com/Toutouwai/FilesRenameReplace
      http://modules.processwire.com/modules/files-rename-replace/
    • By d'Hinnisdaël
      So I decided to wade into module development and created a wrapper module around ImageOptim, a service that compresses and optimizes images in the cloud. ImageOptim currently handles JPG, PNG and GIF files and, depending on the settings you use, shaves off between 15% and 60% in filesize. Great for bandwidth and great for users, especially on mobile.
      This module handles the part of uploading images to ImageOptim via their official API, downloading the optimized version and storing it alongside the original image.
       

       
      Download & Info
      GitHub / Module directory / Readme / Usage
       
      Why ImageOptim?
      There are other image optimization services out there, some of them free, that have outstanding ProcessWire modules. A few things make ImageOptim the best tool for most of my customers: It's not free, i.e. it will probably be around for a while and offers support. However, it's cheaper than some of the bigger competitors like Cloudinary. And it does PNG compression better than any of the free services out there, especially those with alpha channels.
       
      Installation
      Install the module like any other ProcessWire module, by either copying the folder into your modules folder or installing it via the admin. See above for downloads links on GitHub and in the module directory.
       
      Requirements
      To be able to upload images to the service, allow_url_fopen must be set on the server. The module will abort installation if that's not the case.
      I have only tested the module on ProcessWire 3.x installations. I don't see why it shouldn't work in 2.x, if anyone wants to try it out and report back.
       
      ImageOptim account
      To compress images, you first need to sign up for an ImageOptim account. They offer free trials to try the service.
       
      Usage (manual optimization)
      Images can be optimized by calling the optimize() method on any image. You can pass an options array to set ImageOptim API parameters.
      $image->size(800,600)->optimize()->url $image->optimize(['quality' => 'low', 'dpr' => 2]) // Set quality to low and enable hi-dpi mode
      Automatic optimization
      The module also has an automatic mode that optimizes all image variations after resizing. This is the recommended way to use this module since it leaves the original image uncompressed, but optimizes all derivative images.
      $image->size(800,600)->url // nothing to do here; image is optimized automatically
      To change compression setting for single images, you can pass an options array along with the standard ImageResizer options. Passing false disables optimization.
      $image->size(800, 600, ['optimize' => 'medium']) $image->size(800, 600, ['optimize' => ['quality' => 'low', 'dpr' => 2]]) $image->size(800, 600, ['optimize' => false])
      For detailed usage instructions and all API parameters, see the usage instructions on GitHub.
       
      Filenames
      Optimized images will be suffixed, e.g. image.jpg becomes image.optim.jpg. You can configure the suffix in the module settings.
       
      Roadmap
      Asynchronous processing. Not really high on the list. Image variations need to be created anyway, so waiting a few seconds longer on first load is preferable to adding complexity to achieve async optimization. Optimize image variations created by other modules. CroppableImage comes to mind. I don't use any of these, so if somebody wants to help out and submit a pull request — all for it! Add a dedicated page in the setup menu with a dashboard and detailed statistics. ImageOptim's API is very barebones for now, so not sure if that's feasible or even necessary.
      Stability
      I've been using this module on production sites for some time now, without hiccups. If you do notice oddities, feel free to comment here or investigate and submit PRs.
    • By daniels
      General
      This is a lightweight alternative to other newsletter & newsletter-subscription modules.
      It can update / create a subscriber in a list in Mailchimp with MailChimp API 3.0. It does not provide any forms or validation, so you can feel free to use your own. To protect your users, it does not save any user data in logs or sends them to an admin.
      This module fits your needs if you...
      ...use Mailchimp as your newsletter / email-automation tool ...want to let users subscribe to your newsletter on your website ...want to use your own form, validation and messages (with or without the wire forms) ...don't want any personal user data saved in any way in your ProcessWire environment (cf. EU data regulation terms) ...like to subscribe users to different lists ...like the Mailchimp UI for creating / sending / reviewing email campaigns You can find it here: https://github.com/danielstieber/SubscribeToMailchimp
      Let me know what you think and if I should add it to the Modules Directory.
      Setup
      Log into your Mailchimp account and go to  Profile > Extras > API Keys. If you don't have an API Key, create a new one. Copy your API Key and paste it in the module settings (Processwire > Modules > Site > SubscribeToMailchimp). Back in Mailchimp, go to the list, where you want your new subscribers. Go to Settings > List name and defaults. Copy the List ID an paste it in to the module settings.
      Usage
      To use the module, you need to load it into your template:
      $mc = $modules->get("SubscribeToMailchimp"); Now you can pass an email address to the module and it will try to edit (if the user exists) or create a new subscriber in your list.
      $mc->subscribe('john.doe@example.com'); You can also pass a data array, to add additional info.
      $mc->subscribe('john.doe@example.com', ['FNAME' => 'John', 'LNAME' => 'Doe']); You can even choose an alternative list, if you don't want this subscriber in your default list.
      $mc->subscribe('john.doe@example.com', ['FNAME' => 'John', 'LNAME' => 'Doe'], 'abcdef1356'); // Subscribe to List ID abcdef1356  
      Important Notes
      This module does not do any data validation. Use a sever-sided validation like Valitron Make sure that you have set up your fields in your Mailchimp list. You can do it at Settings > List fields and *|MERGE|* tags Example
      Example usage after a form is submitted on your page:
      // ... validation of form data $mc = $modules->get("SubscribeToMailchimp"); $email = $input->post->email; $subscriber = [ 'FNAME' => $input->post->firstname, 'LNAME' => $input->post->lastname, ]; $mc->subscribe($email, $subscriber);  
      Troubleshooting
      In case of trouble check your ProcessWire warning logs.
      I can't see the subscriber in the list
      If you have enabled double opt-in (it is enabled by default) you will not see the subscriber, until he confirmed the subscription in the email sent by Mailchimp
      I get an error in my ProccessWire warning logs
      Check if you have the right List ID and API Key. Check if you pass fields, that exist in your list. Check if you pass a valid email address. Go to Mailchimps Error Glossary for more Information
      How To Install
      Download the zip file at Github or clone directly the repo into your site/modules If you downloaded the zip file, extract it in your sites/modules directory. You might have to change the folders name to 'SubscribeToMailchimp'. Goto the modules admin page, click on refresh and install it  
    • By PWaddict
      Module for hiding pages for non-superusers.
      Download
      HidePages
      Requirements
      ProcessWire 3.x Changelog
      1.0.1 (31 March 2018)
      Module renamed to prevent confusion 1.0.0 (30 March 2018)
      Initial release