Macrura

Module: Field Descriptions Extended

Recommended Posts

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.

Modules Directory: http://modules.processwire.com/modules/field-descriptions-extended/

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:

  1. Install Select Fields module (FieldtypeFields) http://modules.processwire.com/modules/fieldtype-fields/
  2. Create a new field using this field type, e.g. field_select.
  3. Add the field to any template you will be using for your field descriptions.
  4. 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.
  5. 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
  6. 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.

5a0e3f645f8d0_fielddescr.thumb.gif.f33f82c2e5e0c506812bf253ab9346c7.gif

Example setup:

5a0e3fa485233_Edit_Template__basic-page__localhost.thumb.jpg.fcb326a0ae30b32e2e84f10f105c4158.jpg

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.

5a0e4012451bd_fielddescrpanel.thumb.gif.6b051623b6e7b716bccf2e9e3e10366a.gif

  • Like 19
  • Thanks 3

Share this post


Link to post
Share on other sites

very nice :)

in the second example: where does the content come from? a regular page that is linked? what kind of panel is this? is there a reason why you use an uikit panel instead of the built in pw-panel?

Share this post


Link to post
Share on other sites
25 minutes ago, bernhard said:

in the second example: where does the content come from? a regular page that is linked? what kind of panel is this? is there a reason why you use an uikit panel instead of the built in pw-panel?

The 'page content for field description' option works along side the split content; so it is possible to use both as is show in the screen captures. When using the page content option, the content is from a page (e.g. under help pages). The aim is to make it configurable where you can specify which field to use for the content; the textformatters are applied, so you can use markdown if preferred; Right now it is hardcoded to use the body field.

For determining which field to show a link to the page's content on in the description, currently in my usage i have a FieldtypeFields field where you select the field that the content should show up on. The other option would be to just use a text field and have users enter the name of the field, or if multiple then a space or comma separated list; Having the selectable fields using that inputfield is very convenient though and maybe less error prone.

On UiKit theme it uses the uikit panel to show the help info; the actual content is already on the page, output in a hidden div next to the inputfield; so i don't think pw-panel will work since that is all about iframes. I had thought about the idea of creating a process module that would output the content from any page and then be able to use pw-panel, but i'm not sure if it needs to go there, as it would add another sub-module;

On the other themes it shows that content in magnific popup. The main reason i like the panel better than using a popup overall is that i actually have clients who are not super computer savvy or experienced and they are confused by popups and overlays, i've had them close the window because they didn't realize that they were still on the page.

  • Like 1

Share this post


Link to post
Share on other sites

The module is now up on Github in case anyone wants to test it or give it a try.

Some additional features were added, like the ability to use SimpleMDE for field descriptions (on the field edit screen).

There are probably still some things in this module that could be improved overall, but fundamentally it works well and is in heavy use on one site.

This module is being used instead of the Admin Help module now in most cases, because typically the info that editors need to access is always about a specific field, so general instructions on the page editor (like in the help tab or lightbox) do not help as much as here, where targeted/contextual info about how to interact with a specific field is a click away.

  • Like 1

Share this post


Link to post
Share on other sites
Posted (edited)

This module was finally released and in the Modules Directory:

http://modules.processwire.com/modules/field-descriptions-extended/

Future Plans:

  1. Make the 'more' text configurable, as well as multi-langauage
  2. allow specification of which field to use for Field Selection, where the selected field on any content page would be a candidate to get the extended field description (in panel or modal) treatment.
  3. allow specification of which field to use for the content, when in "Page Content for Field Description" mode.

oops, just realized the module already does #2 & #3:

53244234_Modules__ProcessWire__localhost.thumb.jpg.ea8e57522945a647ba79386d4e78163e.jpg

Edited by Macrura
update/correction
  • Like 4

Share this post


Link to post
Share on other sites

@netcarver - thanks for the compliment!

Hope someone else finds this useful; for me this has become a life-saver and the clients/editors have given a lot of positive feedback, and less questions/problems/confusion...  saves a ton on screen real estate when you absolutely have to have a fairly verbose field description, since you can hide most of it under the reveal...

  • Like 4

Share this post


Link to post
Share on other sites

I'm surprised that I actually missed this module.  I will definitely give it a workout on a few projects.  Thanks for your work on quite a few productive modules.

  • Like 1

Share this post


Link to post
Share on other sites

Hi @Macrura

This has a side effect if used on a field that is set to Ajax open (closed and ajax load only when opened) - the entire text is shown, sans link, before the ajax load completes and is shown again, with the 'more' link, once the load completes...

screenshot-0002.png.09f47bfc3a924ac772eafcaaee234e69.png

  • Like 1

Share this post


Link to post
Share on other sites

Hi @netcarver - ok thanks for the report; i'll have to investigate this with ajax opened fields, have not used those much, and didn't test; hopefully it will be a simple fix...

  • Like 1

Share this post


Link to post
Share on other sites

Seems like a nice addition to your in-place documentation module suite, @Macrura:

+

I think that with PW in-place docs are a real help for editors. And you are the expert in this field. I would love to read or watch a screencast about all those modules used together. If you could find time to share your knowledge, that would surely be an awesome gift to the community.

And yes, that is just a fancy way to ask something free for myself 😔

  • Like 2

Share this post


Link to post
Share on other sites

@Ivan Gretsky  -thanks; sure - in short:

FieldDescriptionsExtended

Enhanced field descriptions

ProcessDocumentation

Main function is to provide help pages in the admin which can be separate, and navigable; Since you can control the pages, it allows admins to have any documentation page open in a separate tab or window; contrasting to Admin Help, which has the help information either contextually on the Template (in a tab) or all in 1 process page inside an accordion.

This module also allows editors to download a PDF of the help page for offline reading, as well as various other helpers.

AdminHelp

Original module, not being actively maintained, but soon all of the elements of this module would be covered by ProcessDocumentation. Still helpful if you want the simple help tab on a template, or some basic documentation for a site, all on 1 process page, in an accordion.

-----

The next version of ProcessDocumentation will include a feature to show help content contextually on any template, using a help icon in the breadcrumbs bar instead of down in the editor tabs. In addition it will allow for showing expandable/collapsible help text at the top of any Lister/ListerPro. So in the end, ProcessDocumentation should cover most needs for fully documenting and providing help for any admin.

 

  • Like 4

Share this post


Link to post
Share on other sites
On 7/20/2018 at 6:06 AM, netcarver said:

This has a side effect if used on a field that is set to Ajax open (closed and ajax load only when opened) - the entire text is shown, sans link, before the ajax load completes and is shown again, with the 'more' link, once the load completes...

An update was made to the module to fix this;

Please proceed cautiously and if you experience any errors or unexpected behavior let me know and revert to the previous version.

bunch of things got moved around in the module; testing was done and all seems to work fine, but due to the large number of changes in this update, caution is advised;

  • Like 2

Share this post


Link to post
Share on other sites

Thanks for the update and warning note, @Macrura. I'll test this later on a development box.

Update: Seems to work for me now, thank you!

Share this post


Link to post
Share on other sites

The module instructions are rendered here on pw 3.0.108 as plain text instead html. Changing line 456-457 to this solves the issue (removing translate function):

$f->markupText = file_get_contents(__DIR__ . '/instructions.php');

Perhaps this happens only on a multilanguage site or where SimpleMDE is not installed?

Share this post


Link to post
Share on other sites

@tpr - thanks, no idea what the issue is, it works fine here, but i can make that change, as this issue was reported on another module, i think it is multilang related

Share this post


Link to post
Share on other sites

Ok, thanks! I was about to try the module but I wasn't able to get through this 🙂

Share this post


Link to post
Share on other sites

ok thanks for trying it – i will put this in the next update, in the meantime if you can make that fix, you should be able to use it (?)

Share this post


Link to post
Share on other sites

Sure, I was just more interested in the cause but will try the module soon 🙂

  • Like 2

Share this post


Link to post
Share on other sites

Create an account or sign in to comment

You need to be a member in order to leave a comment

Create an account

Sign up for a new account in our community. It's easy!

Register a new account

Sign in

Already have an account? Sign in here.

Sign In Now

  • Recently Browsing   0 members

    No registered users viewing this page.

  • Similar Content

    • By BitPoet
      MediaLibrary
      Update: MediaLibrary can now be found in the official module list.
      Out of necessity, I've started to implement a simple media library module.
      The basic mechanism is that it adds a MediaLibrary template with file and image fields. Pages of this type can be added anywhere in the page tree.
      The link and image pickers in CKEditor are extended to allow quick selection of library pages from dropdowns. In the link picker this happens in the MediaLibrary tab, where you can also see a preview of the selected image. In the image picker, simply select a library from the dropdown at the top, everything else is handled by standard functionality.
      I've put the code onto github. This module is compatible with ProcessWire 3.
      Steps to usage:
      Download the module's zip from github (switch to the pw3 branche beforehand if you want to test on PW 3.x) and unpack it into site/modules Click "Modules" -> "Refresh" in the admin Click "Install" for MediaLibrary For testing, create a page with the MediaLibrary template under home (give it an expressive title like 'Global Media') and add some images and files Edit a differnt page with a CKEditor field and add a link and an image to see the MediaLibrary features in action (see the screencap for details) Optionally, go into the module settings for MediaLibrary Note: this module is far from being as elaborate as Kongondo's Media Manager (and doesn't plan to be). If you need a feature-rich solution for integrated media management, give it a look.
      Feel free to change the settings for MediaFiles and MediaImages fields, just keep the type as multiple.
      There are some not-so-pretty hacks for creating and inserting the correct markup, which could probably be changed to use standard input fields, though I'm a bit at a loss right now how to get it to work. I've also still got to take a look at error handling before I can call it fit for production. All feedback and pointers are appreciated (that's also why I post this in the development section).

      Edit 09.03.2016 / version 0.0.4: there's now also a "Media" admin page with a shortcut to quickly add a new library.

      Edit 01.05.2016:
      Version 0.0.8:
      - The module now supports nested media libraries (all descendants of eligible media libraries are also selectable in link/image picker).
      - There's a MediaLibrary::getPageMediaLibraries method you can hook after to modify the array of available libraries.
      - You can switch between (default) select dropdowns or radio boxes in the module configuration of MediaLIbrary to choose libraries.
      Edit 10.10.2018:
      Version 0.1.3:
      - Dropped compatibility for ProcessWire legacy versions by adding namespaces
      - Allow deletion of libraries from the Media overview admin page
      - Added an option to hide media libraries from the page tree (optionally also for superusers)
    • By Robin S
      This module corrects a few things that I find awkward about the "Add New Template" workflow in the PW admin. I opened a wishlist topic a while back because it would good to resolve some of these things in the core, but this module is a stopgap for now.
      Originally I was going to share these as a few standalone hooks, but decided to bundle them together in a configurable module instead.
      Add Template Enhancements
      A module for ProcessWire CMS/CMF. Adds some efficiency enhancements when adding or cloning templates via admin.

      Features
      Derive label from name when new template added: if you like to give each of your templates a label then this feature can save some time. The label can be added automatically when templates are added in admin, in admin/API, or not at all. There are options for underscore/hyphen replacement and capitalisation of the label. Edit template after add: when adding only a single template, the template is automatically opened for editing after it is added. Copy field contexts when cloning: this copies the field contexts (a.k.a. overrides such as column width, label and description) from the source template to the new template when using the "Duplicate/clone this template?" feature on the Advanced tab. Copy field contexts when duplicating fields: this copies the field contexts if you select the "Duplicate fields used by another template" option when adding a new template. Usage
      Install the Add Template Enhancements module.
      Configure the module settings according to what suits you.
       
      https://github.com/Toutouwai/AddTemplateEnhancements
      https://modules.processwire.com/modules/add-template-enhancements/
    • By Mike Rockett
      As I mentioned in this issue, I've create a new textformatter for ParsedownExtraPlugin, which adds some oomph to your markdown.
      Repo: Parsedown Extra Plugin
      Unlike the built-in textformatter for Parsedown and Parsedown Extra, this should be used when you want to use Extra with additional configuration/customisation.
      Some examples:
      ### Test {.heading} - A [external link](https://google.com/){.google} with `google` as a class that opens in a new tab if the config property is set. - [Another link](/page){target=_blank} that opens in a new tab even though it isn't external. ```html .html <p>Test</p> ``` There's some config options available to you, such as setting attributes on all/external images and links, setting table and table-cell alignment classes, adjusting footnote classes and IDs, adding <code> attributes to their parent <pre> elements, and changing the <code> class if your syntax highlighter does not use language-*.
      I was thinking about adding the ability to make links open in a new tab by appending a plus to the link syntax, but only external links should be opening in a new tab anyway. Further, this would add extra, unnecessary processing time.
      Please let me know if you bump into any problems. ☺️
    • By Mike Rockett
      TextformatterTypographer (0.4.0 Beta)
      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.
      Learn more on my blog
      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.
      Please do test it out and let me know what you think.
      Also note that I have indicated support for PW 2.8, but I haven't tested there as yet. This was built on PW 3.0.42/62.
    • By Mike Rockett
      Jumplinks for ProcessWire
      Release: 1.5.50
      Jumplinks is an enhanced version of the original ProcessRedirects by Antti Peisa.
      The Process module manages your permanent and temporary redirects (we'll call these "jumplinks" from now on, unless in reference to redirects from another module), useful for when you're migrating over to ProcessWire from another system/platform. Each jumplink supports wildcards, shortening the time needed to create them.
      Unlike similar modules for other platforms, wildcards in Jumplinks are much easier to work with, as Regular Expressions are not fully exposed. Instead, parameters wrapped in curly braces are used - these are described in the documentation.
      Under Development: 2.0, to be powered by FastRoute
      As of version 1.5.0, Jumplinks requires at least ProcessWire 2.6.1 to run.
      View on GitLab
      Download via the Modules Directory
      Read the docs
      Features
      The most prominent features include:
      Basic jumplinks (from one fixed route to another) Parameter-based wildcards with "Smart" equivalents Mapping Collections (for converting ID-based routes to their named-equivalents without the need to create multiple jumplinks) Destination Selectors (for finding and redirecting to pages containing legacy location information) Timed Activation (activate and/or deactivate jumplinks at specific times) 404-Monitor (for creating jumplinks based on 404 hits) Additionally, the following features may come in handy:
      Stale jumplink management Legacy domain support for slow migrations An importer (from CSV or ProcessRedirects) Feedback & Feature Requests
      I’d love to know what you think of this module. Please provide some feedback on the module as a whole, or even regarding smaller things that make it whole. Also, please feel free to submit feature requests and their use-cases.
      Note: Features requested so far have been added to the to-do list, and will be added to 2.0, and not the current dev/master branches.
      Open Source

      Jumplinks is an open-source project, and is free to use. In fact, Jumplinks will always be open-source, and will always remain free to use. Forever. If you would like to support the development of Jumplinks, please consider making a small donation via PayPal.
      Enjoy!