adrian

Page Field Select Creator

Recommended Posts

This module provides a way to rapidly generate Page fields and the required templates and pages for use as a drop down select (or any other Page field type).

This module will let you create a full page field setup in literally a few seconds  :)

To use, run Page Field Select Creator from the Setup Menu

  • Enter a Field Title, eg: Room Types
  • Select Options - These will become the child pages that will populate the page field select options. There are two different options.
     
    Option 1. TITLE FIELD ONLY - enter one option per line, eg:
     
    Single
    Double
    Suite
     
     
    Option 2. MULTIPLE FIELDS - the first line is used for the field names and the first field must be 'Title'. Subsequent lines are the values for the fields, eg:
     
    Title, Number of Beds, Number of People, Kitchen Facilities
    Single, 1, 1, Fridge Only
    Double, 2, 2, Fridge Only
    Suite, 3, 6, Full Kitchen
     
  • Choose the parent where the page tree of options will be created, eg a hidden "Options" parent page
  • Select a "Deference in API as" option depending on your needs
  • Choose the input field type
  • Check whether "Allow new pages to be created from field?" should be enabled.

As an example, if you entered "Room Types" as the field title, you would end up with all of the following automatically created:

  • a fully configured page field called: room_types
  • MULTIPLE FIELDS OPTION - 3 additional fields - number_of_beds, number_of_people, kitchen
  • a parent template called: room_types
  • a child template called: room_types_items (with either just a title field, or with the 3 additional fields as well)
  • a parent page called: Room Types
  • a series of child pages named and titled based on the per line entries in the Select Options textarea

The templates are configured such that the "room_types_items" child template can only have the main "room_types" template as a parent, and vice versa.

Then all you have to do is add the newly created page field to any template you want and you're ready to go!
 
You can grab it from:
 
Modules directory: http://mods.pw/5R
Github: https://github.com/adrianbj/ProcessPageFieldSelectCreator

I'd appreciate some feedback on whether others would find this useful, and if you agree with the default way the template structure and family settings are being configured. Then I'll add to the modules directory.

post-985-0-49927700-1379441662_thumb.png

  • Like 18

Share this post


Link to post
Share on other sites

This is great Adrian, extremely handy!

As this is a more advantaged tool I was thinking of:

Select a template to use as child page ( with more fields in a template )

Say you select a child template with the fields: title, type & year.

Then at Select Options:

BMW, m3, 1987

Mazda, 323, 1986

VW, Golf, 2012

---

Even without this it's a real time saver !!!

  • Like 1

Share this post


Link to post
Share on other sites

Greetings,
Excellent concept! I just experimented with it briefly this morning. Will use it more later...

One of the most common newcomer misunderstandings about ProcssWire is the "missing" dropdown field. Your module gets us closer to using the depth of ProcessWire pages as selects while being easier to set up.

Thanks for doing this!

Matthew

  • Like 1

Share this post


Link to post
Share on other sites

Thanks for the positive feedback everyone. 

Matthew - that was definitely part of my reasoning for creating this. There are a few times I have wanted to set up a page field, but have gone with hani's fieldtype Select module to save time. I still think there are times when his module is more appropriate, but now I think I won't be making the decision because of the time/hassle of creating a page field setup. It is also why I chose to put "Select" in the name of the module - hopefully it will help newcomers find it more easily.

Martijn - I like where you are headed with those ideas. I think rather than selecting an existing child template (which I think is what you are suggesting), how about I allow the Select Options field to also handle multiple fields if entered? I might take a stab at that and see how it goes - stay tuned!

  • Like 3

Share this post


Link to post
Share on other sites

<adrian>how about I allow the Select Options field to also handle multiple fields if entered? I might take a stab at that and see how it goes - stay tuned!</adrian>

I didn't thought about that, but thats even better, thumbs up !

Share this post


Link to post
Share on other sites
Hi everyone.

The new functionality based on Martijn's suggestions for creating the select options with multiple fields is ready. I have updated the code on Github and modified the instructions in the first post above.

Please test and let me know how it goes for you and whether there are any improvements I could make.

  • Like 4

Share this post


Link to post
Share on other sites

Adrian, thanks for the update! If possible, it would have been nice to have a before (original version) and after this update text and screenshots (I know could potentially lead to a long thread and not practical with every update). It helps to compare, follow progress, etc. Not a big deal though... ;)

Share this post


Link to post
Share on other sites

Adrian I think you broke something in your latest commit.

In the option with multiple fields

The pagefield, doesn't store the Parent Page.

ps, I'm smiling while using this Module  :) 

(aside: People have to take care they're not creating a Hani amount of fields )

  • Like 1

Share this post


Link to post
Share on other sites

Works ! 

$field->notes at Select Options contain a lot of text. Maybe move the to $field->desc.

And use the $field->notes to echo out all compatible text based fields.

ps, your implementation of my suggestion is way better then how I thought about it.

Share this post


Link to post
Share on other sites

Glad to hear it's working again!

I don't mind moving the examples for the Select Options field to the desc, but I am actually not sure what you mean by:

"echo out all compatible text based fields"

Do you mean all existing text fields from the entire site? I am not sure what would make them compatible or not.

Remember that any new specified fields are created on the fly and added to the child template's fieldgroup - there is no need to have those fields already defined.

Sorry, I think I am just not understanding what you mean :)

Share this post


Link to post
Share on other sites

<adrian>Do you mean all existing text fields from the entire site? I am not sure what would make them compatible or not</adrian>

Yep that is what I meant.

Reuse of existing fields makes sense, so it would be nice to see a list of all fields that extends from FieldtypeText. ( all compatible I think )

Share this post


Link to post
Share on other sites

Good point - v4 is now available and includes a list of available text fields that can be used instead of automatically creating new ones if appropriate.

  • Like 1

Share this post


Link to post
Share on other sites

Wil test tomorrow, thanks for all your effort!

Did the testings this morning... simply love it.

Thanks for bringing in my ideas !

Edited by Martijn Geerts
  • Like 1

Share this post


Link to post
Share on other sites

Hey, no worries - I was going to be working on another new module today, but may as well get this one perfected first :)

What exactly do you think it needs and how do you see it working? I have played around with multi languages in PW a little, but since I don't really have a need, I am still not terribly literate with it yet.

Am I correct in assuming that you wouldn't really need multi-language versions of the title of the Parent page? I am thinking you'd only need them for all fields of the child pages?

So, would having separate "Select Options" textarea fields for each installed language cover everything needed?

It would be great if you could detail out how you think it would work best so I don't go down a confusing path!

Sorry for being an ignorant English speaker :)

PS Go grab v6 from Github - some restructuring of the form - layout and instructions, fixing of a bug if the field already existed, and more friendly error reporting in general.

Edited by adrian
  • Like 1

Share this post


Link to post
Share on other sites

All strings can be translated in PW.

It is as easy as. $this->_("provide your english here") or __("provide your english here") instead of "provide your english here"

Then If someone needs to translate your module the translatable strings are in there. 

  1. The translator should go to /Setup/Languages/ 
  2. Then to the language, say Dutch.
  3. There fill in the path of your module
  4. ProcessWire will detect all __('translatable strings') & $this->_('translatable strings') and present the translator with inputs.
  5. Then The translator can type in "vertaalbare tekst" go to the next, etc. translate them all.
  6. Save... Done

$field->description = __("Fringilla Sollicitudin Consectetur"); or $field->description = _$this->_("Fringilla Sollicitudin Consectetur");

To make it more fancy, use the sprintf or printf

printf(__("Created %d pages."), $count);


example

protected function buildForm1() {
  $f = $this->modules->get("InputfieldText");
  $f->name = 'fieldTitle';
  $f->label = __('Field Title');
  $f->required = true;
  $f->description = __("The title of the page field to be created.");
  $f->notes = __("Use capitals, spaces etc.");
  $form->add($f);
  .....
}
  • Like 2

Share this post


Link to post
Share on other sites

Ok, now I understand - I wasn't thinking about making the module's form translatable. I thought you meant having the option for creating the selectable child pages have multi-language fields.

Thanks a lot for the detailed example - I'll take care of it now and hopefully you can let me know if I have missed anything. Should/can the name of the module itself be translatable?

Share this post


Link to post
Share on other sites

Just a little note to the translations:

If you're in a class context (extending Wire), the way to translate strings is like this: 

$this->_('Your string to translate');

Whereas in templates, there's the following syntax to use:

__('Translate me baby');

Great module :)

  • Like 1

Share this post


Link to post
Share on other sites

OK, v7 now has translations support!

Wanze - thanks for the translation info. I had just finished when your message came through. Everything seems to be working fine. Maybe you could take a look for me and let me know if I need to change any of them.

One other question for you guys - wasn't quite sure the best way to handle multiline description fields. In the case of the "Select Options" field, I think I may have made the translation more complicated than it really needs to be. Perhaps it would be better to put all in one translatable field and require the translator to include these as required. Trouble is that the title and description on the translation page don't get formatted, so it is hard to see what the intended layout actually is. Do you have any advice?

Anything I missed?

Share this post


Link to post
Share on other sites

Hey guys,

I have been playing around trying to better understand multi-language stuff and it seems to me that along with the module translation that I just set up, it would also make sense to be able to automatically fill in the alternate language(s) for the fields of the sub-pages - in my example, the values for: Title, Number of Beds, Number of People, Kitchen Facilities.

So, if you had three languages installed you'd be given three "Select Options" fields, one for each language. Based on my standard example, you'd fill out something like this:

English

Title, Number of Beds, Number of People, Kitchen Facilities

Single, 1, 1, Fridge Only

Double, 2, 2, Fridge Only

Suite, 3, 6, Full Kitchen

Dutch

Titel, aantal bedden, aantal personen, ingerichte keuken

Alleenstaand, 1, 1, Koelkast Alleen
Dubbel, 2, 2, Alleen Koelkast

Vervolg, 3, 6, volledige keuken

German

Titel, Anzahl der Betten, Anzahl von Menschen, Küchen

Einzel, 1, 1, Kühlschrank Nur

Doppel, 2, 2, Kühlschrank Nur

Weiterführung, 3, 6, komplett ausgestattete Küche

Would this be useful, or is this not how you guys handle things for the content pages for a Page field.

PS Excuse the dodgy google translations - no offense intended :)

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 FrancisChung
      Hi,
      I was wondering if anyone knew what this did? 

      If so, do you know what modules it actually impacts? Is there another log that lists the action it took?

      I'm having some weird problems with PHP duplicate declaration per link below, since this module was run.
       
       
    • By tpr
      AdminOnSteroids
      Various admin tweaks to enhance ProcessWire admin.
      http://modules.processwire.com/modules/admin-on-steroids/
      https://github.com/rolandtoth/AdminOnSteroids

    • By Macrura
      Field Descriptions Extended
      This module enables you to extend field descriptions by dividing short descriptions with a longer text that is revealed in a toggle.
      Github: https://github.com/outflux3/FieldDescriptionsExtended
      Extending your field descriptions using the standard field's description field.
      Once this module is installed, it will automatically search your description field for the presence of 5 dashes (-----).
      Any content above the 5 dashes will be visible and the content below the dashes will be hidden. A 'More...' link will appear at the end of the short description which when clicked will reveal the rest of the description.
      Using Simple Markdown Editor with the description field
      If you have Simple Markdown Editor (InputfieldSimpleMDE) installed, you can enable the field description to have that editor.
      *When using Simple MDE, you can use the button (Insert Horizontal Line) instead of typing 5 dashes. More about SimpleMDE.
      Extending your field descriptions using content from a ProcessWire Page for the field description.
      You may use the content from a ProcessWire page as a field description. This would allow you to easily insert images, links, and use hanna codes.
      To use page content for your field descriptions, please follow these instructions:
      Install Select Fields module (FieldtypeFields) http://modules.processwire.com/modules/fieldtype-fields/ Create a new field using this field type, e.g. field_select. Add the field to any template you will be using for your field descriptions. Setup your help pages (for example under a settings branch) where you will store the field description content,using the template containing the Field Select. Add content to a page and select the field where that content should show. To show a short text before the link to the longer content, separate them with 5 dashes Be sure to update your settings on this page, first enable page content descriptions,then specify the name of the Select Fields field, template to search, and content field. If you create a field description using this method, please note that the description field must be blank for contexts where you want the page content to appear.
      You can freely use template context for field descriptions, but the Page Content method is not context sensitive and will display under all contexts where the description is blank.
      ----
      original post:
      This is a new module, hope to release soon, which allows extended field descriptions, in currently 2 ways.
      The main feature of the module is that you can have a short description and then a 'more...' link which drops down a longer block of text.
      This is achieved by separating the intro/visible text and the rest with 5 dashes.

      Example setup:

      the 2nd way is if you are using AdminThemeUiKit, you can show extended field instructions in a panel. The content of the panel is edited on a regular PW page. This use case would probably not be that common, but if you had a field that required some extended instructions for how to use, this could be useful; Also, since this allows you to target information and instructions down at the field level, it could reduce the amount of documentation needed on a global level, since it is a lot more context targeted.

    • By netcarver
      Part 1 of a 2 part Module & Service Reveal.
      I'm currently working on a new module: ModuleReleaseNotes that was inspired by the work I originally did on making Ryan's ProcessWireUpgrades module "release" aware. In the end, I decided to ditch the approach I was originally taking and instead work on a module that hooked in to the UpgradeConfirmation dialog and the module edit page.
      Aims
      My aims for this module are as follows...
      Make discovery of a module's changes prior to an upgrade a trivial task. Make breaking changes very obvious. Make reading of a module's support documentation post-install a trivial task. Make module authors start to think about how they can improve the change discovery process for their modules. Make sure the display of information from the module support files/commit messages doesn't introduce a vulnerability. Looking at these in turn...
      Making discovery of a module's changes prior to upgrade a trivial task.
      This is done by adding a "What's changed section" to the upgrade confirmation dialog.  This section takes a best-effort approach to showing what's changed between the installed version and the updated version that's available via the module repository.
      At present, it is only able to talk to github-hosted repositories in order to ask them for the release notes, the changelog file (if present) and a list of commits between the git tag that matches the installed version and the tag matching the latest version.
      It will display the Release Notes (if the author is using the feature), else it will display the commits between the tags (if tagging is used by the module author) else it will show the changelog file (if present) else it will show the latest N commits on the master branch (N, of course, being configurable to your liking.)
      An example of the Github Release Notes pulled in for you, taken from Mike Rockett's TextformatterTypographer Module...

      An example of a tag-to-tag commit list from the same module...

      An example of a changelog - formatted to show just the changes (formatting styles will change)...

      Finally, an example of a fallback list of commits - sorry Adrian ...

       
      Making breaking changes obvious.
      This is currently done by searching for a set of configurable search strings. Later versions may be able to support breaking change detection via use of Semantic Versioning - but this may require some way of signalling the use of this versioning standard on a module-by-module basis.
      For now, then, you can customise the default set of change markers. Here I have added my own alias to the list of breaking change markers and the changes section of the changelog is styled accordingly (these will be improved)...

       
      Make reading of a module's support documentation, post-install, a trivial task.
      This is done by making some of the support files (like the README, CHANGELOG and LICENSE files) readable from the module's information/settings screen. There is an option to control the initial open/closed state of this section...

      Here is Tracy's README file from within the module settings page... 

       
      Make module authors start to think about how they can improve the change discovery process for their modules.
      There are notes in each of the sections displayed on the upgrade confirmation page that help authors use each of the features...

       
      Make sure display of external information doesn't introduce a vulnerability.
      This is an ongoing concern, and is the thing that is most likely to delay or prevent this module's release lead to this module's withdrawl should a vulnerability be found. Currently, output is formatted either via Markdown + HTML Purifier (if it was originally a Markdown file) or via htmlspecialchars() if it has come from a plaintext file.
      If you discover a vulnerability, please get in contact with me via the forum PM system.
       
      Ongoing...
      For now, I've concentrated on integration with GitHub, as most people use that platform to host their code. I know a few people are hosting their repositories with BitBucket (PWFoo comes to mind) and some with GitLab (Mike Rockett?) and I would eventually like to have adaptor implementations for these providers (and perhaps GitKraken) - but for now, GitHub rules and the other hosts are unsupported.
       
      Links
      Github: ModuleReleaseNotes
      PW Module Repository: Here (pending?)