adrian

Page Field Select Creator

61 posts in this topic

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

18 people like this

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

1 person likes this

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

1 person likes this

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!

3 people like this

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.

4 people like this

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 )

1 person likes this

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.

1 person likes this

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
1 person likes this

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
1 person likes this

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);
  .....
}
2 people like this

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 :)

1 person likes this

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 ethfun
      I've created a Process Module, and its execute() function renders the HTML response to an AJAX request. The AJAX request is being made outside of the admin panel, and in all likelihood will be made by "guest" users.
      Within my ModuleName.info.json file, I have added these lines:
      "permission": "generate-thumbnails", "permissions": { "generate-thumbnails": "Generate Thumbnails" }, Then within the Admin panel, I gave guests access to run that module.
      Unless logged in, the response to the AJAX request is always the login form's HTML, rather than the HTML my execute() function creates.
      So two questions:
      Is it possible to give non-logged-in users the ability to run that function via the AJAX request, or Is there a better ProcessWire way to create HTML to use as an AJAX response? Thank you!
    • By Robin S
      I have had this module sitting in a 95% complete state for a while now and have finally made the push to get it out there. Thanks to @teppo for his Hanna Code Helper module which I referred to and borrowed from during development.
      http://modules.processwire.com/modules/hanna-code-dialog/
      https://github.com/Toutouwai/HannaCodeDialog
      HannaCodeDialog
      A module for ProcessWire CMS/CMF. Provides a number of enhancements for working with Hanna Code tags in CKEditor. The main enhancement is that Hanna tags in a CKEditor field may be double-clicked to edit their attributes using core ProcessWire inputfields in a modal dialog.
      Requires the Hanna Code module.
      Installation
      Install the HannaCodeDialog module using any of the normal methods.
      For any CKEditor field where you want the "Insert Hanna tag" dropdown menu to appear in the CKEditor toolbar, visit the field settings and add "HannaDropdown" to the "CKEditor Toolbar" settings field.
      Module configuration
      Visit the module configuration screen to set any of the following:
      Exclude prefix: Hanna tags named with this prefix will not appear in the CKEditor toolbar dropdown menu for Hanna tag insertion. Exclude Hanna tags: Hanna tags selected here will not appear in the CKEditor toolbar dropdown menu for Hanna tag insertion. Background colour of tag widgets: you can customise the background colour used for Hanna tags in CKEditor if you like. Dialog width: in pixels Dialog height: in pixels Features
      Insert tag from toolbar dropdown menu
      Place the cursor in the CKEditor window where you want to insert your Hanna tag, then select the tag from the "Insert Hanna tag" dropdown.

      Edit tag attributes in modal dialog
      Insert a tag using the dropdown or double-click an existing tag in the CKEditor window to edit the tag attributes in a modal dialog.

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

      Options for tag attributes may be defined
      You can define options for a tag attribute so that editors must choose an option rather than type text. This is useful for when only certain strings are valid for an attribute and also has the benefit of avoiding typos.
      Add a new attribute for the Hanna tag, named the same as the existing attribute you want to add options for, followed by "__options". The options themselves are defined as a string, using a pipe character as a delimiter between options. Example for an existing attribute named "vegetables":
      vegetables__options=Spinach|Pumpkin|Celery|Tomato|Brussels Sprout|Potato You can define a default for an attribute as normal. Use a pipe delimiter if defining multiple options as the default, for example:
      vegetables=Tomato|Potato Dynamic options
      Besides defining static options as above, you can use one Hanna tag to dynamically generate options for another. For instance, you could create a Hanna tag that generates options based on images that have been uploaded to the page, or the titles of children of the page.
      Your Hanna tag that generates the options should echo a string of options delimited by pipe characters (i.e. the same format as a static options string).
      You will probably want to name the Hanna tag that generates the options so that it starts with an underscore (or whatever prefix you have configured as the "exclude" prefix in the module config), to avoid it appearing as an insertable tag in the HannaCodeDialog dropdown menu.
      Example for an existing attribute named "image":
      image__options=[[_images_on_page]] And the code for the _images_on_page tag:
      <?php $image_names = array(); $image_fields = $page->fields->find('type=FieldtypeImage')->explode('name'); foreach($image_fields as $image_field) { $image_names = array_unique( array_merge($image_names, $page->$image_field->explode('name') ) ); } echo implode('|', $image_names); Choice of inputfield for attribute
      For attributes which you have defined options for, you can choose the inputfield that is used to select from the options.
      Inputfields that support the selection of a single option are select (this is the default inputfield for attributes with options so it isn't necessary to specify it if you want it) and radios.
      Inputfields that support the selection of multiple options are selectmultiple, asmselect and checkboxes.
      You can also specify a checkbox inputfield - this is not for attributes with defined options but will limit an attribute to an integer value of 1 or 0.
      The names of the inputfield types are case-insensitive.
      Example for an existing attribute named "vegetables":
      vegetables__type=asmselect Descriptions and notes for inputfields
      You can add a description or notes to an attribute and these will be displayed in the dialog.
      Example for an existing attribute named "vegetables":
      vegetables__description=Please select vegetables for your soup. vegetables__notes=Pumpkin and celery is a delicious combination. Notes
      When creating or editing a Hanna tag you can view a basic cheatsheet outlining the HannaCodeDialog features relating to attributes below the "Attributes" config inputfield.
      Troubleshooting
      HannaCodeDialog includes and automatically loads the third-party CKEditor plugins Line Utilities and Widget. If you have added these plugins to your CKEditor field already for some purpose and experience problems with HannaCodeDialog try deactivating those plugins from the CKEditor field settings.
    • By gRegor
      Updated 2017-03-27:
      Version 1.1.3 released
      Updated 2016-04-11:
      Version 1.1.2 released

      Updated 2016-02-26:
      Officially in the module directory! http://modules.processwire.com/modules/webmention/

      Updated 2016-02-25:
      Version 1.1.0 is now released. It's been submitted to the module directory so should appear there soon. In the meantime, it's available on GitHub: https://github.com/gRegorLove/ProcessWire-Webmention. Please refer to the updated README there and let me know if you have any questions!
      ------------
      Original post:
       
      This is now out of date. I recommend reading the official README.
       
      I've been working on this one for a while. It's not 100%, but it is to the point I'm using it on my own site, so it's time for me to release it in beta. Once I finish up some of the features described below, I will submit it to the modules directory as a stable plugin.
      For now, you can install from Github. It works on PW2.5. I haven't tested on PW2.6, but it should work there.
      Feedback and questions are welcome. I'm in the IRC channel #processwire as well as #indiewebcamp if you have any questions about this module, webmention, or microformats.
      Thanks to Ryan for the Comments Fieldtype which helped me a lot in the handling of webmentions in the admin area.
      ProcessWire Webmention Module
      Webmention is a simple way to automatically notify any URL when you link to it on your site. From the receiver's perspective, it is a way to request notification when other sites link to it.
      Version 1.0.0 is a stable beta that covers webmention sending, receiving, parsing, and display. An easy admin interface for received webmentions is under development, as well as support for the Webmention Vouch extension.
      Features
      * Webmention endpoint discovery
      * Automatically send webmentions asynchronously * Automatically receive webmentions * Process webmentions to extract microformats   Requirements * php-mf2 and php-mf2-cleaner libraries; bundled with this package and may optionally be updated using Composer. * This module hooks into the LazyCron module.   Installation Github: https://github.com/gRegorLove/ProcessWire-Webmention

      Installing the core module named "Webmention" will automatically install the Fieldtype and Inputfield modules included in this package.   This module will attempt to add a template and page named "Webmention Endpoint" if the template does not exist already. The default location of this endpoint is http://example.com/webmention-endpoint   After installing the module, create a new field of type "Webmentions" and add it to the template(s) you want to be able to support webmentions. Sending Webmentions
      When creating or editing a page that has the Webmentions field, a checkbox "Send Webmentions" will appear at the bottom. Check this box and any URLs linked in the page body will be queued up for sending webmentions. Note: you should only check the "Send Webmentions" box if the page status is "published."   Receiving Webmentions This module enables receiving webmentions on any pages that have have "Webmentions" field, by adding the webmention endpoint as an HTTP Link header. If you would like to specify a custom webmention endpoint URL, you can do so in the admin area, Modules > Webmention.   Processing Webmentions (beta) Currently no webmentions are automatically processed. You will need to browse to the page in the backend, click "Edit," and scroll to the Webmentions field. There is a dropdown for "Visibility" and "Action" beside each webmention. Select "Process" to parse the webmention for microformats.   A better interface for viewing/processing all received webmentions in one place is under development.   Displaying Webmentions (beta) Within your template file, you can use `$page->Webmentions->render()` [where "Webmentions" is the name you used creating the field] to display a list of approved webmentions. As with the Comments Fieldtype, you can also generate your own output.   The display functionality is also under development.   Logs This module writes two logs: webmentions-sent and webmentions-received.   Vouch The Vouch anti-spam extension is still under development.   IndieWeb The IndieWeb movement is about owning your data. It encourages you to create and publish on your own site and optionally syndicate to third-party sites. Webmention is one of the core building blocks of this movement.   Learn more and get involved by visiting http://indiewebcamp.com.   Further Reading * http://indiewebcamp.com/webmention * http://indiewebcamp.com/comments-presentation * http://indiewebcamp.com/reply
    • By kixe
      This morning I pushed a module to github which extends the page api with moving and sorting capability.
      https://github.com/kixe/PageSortMove
      /** * CALLABLE * PageSortMove::execute($pageID, $newIndex = 0, $parentID = null); * $modules->get('PageSortMove')->execute($pageID, $newIndex = 0, $parentID = null); * * EXTENDED PAGE API * @property $page->first // under same parent * @property $page->last * * @method $page->first($parentID = null) * @method $page->last($parentID = null) * @method $page->sort($newIndex) * @method $page->move($newIndex, $parentID = null) */ Have a nice weekend.