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 OLSA
      Hello for all,
      ConfigurationForm fieldtype module is one my experiment from 2016.
      Main target to build this module was to store multiple setup and configuration values in just 1 field and avoid to use 1 db table to store just single "number of items on page", or another db table to store "layout type" etc. Thanks to JSON formatted storage this module can help you to reduce number of PW native fields in project, save DB space, and reduce number of queries at front-end.
      Install and setup:
      Download (at the bottom ), unzip and install like any other PW module (site/modules/...). Create some filed using this type of field (ConfigurationForm Fieldtype) Go to field setup Input tab and drag some subfields to container area (demo). Set "Name" and other params for subfields Save and place field to templates ("Action tab") How to use it:
      In my case, I use it to store setup and configurations values, but also for contact details, small content blocks... (eg. "widgets").
      Basic usage example:
      ConfigForm fieldtype "setup" has subfields:
      "limit", type select, option values: 5, 10, 15, 20
      "sort", type select, option values: "-date", "date",  "-sort", "sort"
      // get page children (items) $limit = isset($page->setup->limit) ? $page->setup->limit : 10; $sort = isset($page->setup->sort) ? $page->setup->sort : '-sort'; $items = $page->children("limit=$limit, sort=$sort");  
      Screenshots:


       
      Notes:
      Provide option to search inside subfields Provide multilanguage inputs for text and textarea field types Provide option for different field layout per-template basis Do not place/use field type "Button" or "File input" because it won't works. Please read README file for more details and examples Module use JSON format to store values. Text and textarea field types are multilanguage compatible, but please note that main target for this module was to store setup values and small content blocks and save DB space. Search part inside JSON is still a relatively new in MySQL (>=5.77) and that's on you how and for what to use this module.
      Thanks:
      Initial point for this fieldtype was jQuery plugin FormBuiled and thanks to Kevin Chappel for this plugin.
      In field type "link" I use javascript part from @marcostoll module and thanks to him for that part.
      Download:
      FieldtypeConfigForm.zip
      Edit: 14. August 2018. please delete/uninstall previously downloaded zip
      Regards.
         
    • By bernhard
      @Sergio asked about the pdf creation process in the showcase thread about my 360° feedback/survey tool and so I went ahead and set my little pdf helper module to public.
      Description from PW Weekly:
       
      Modules Directory: https://modules.processwire.com/modules/rock-pdf/
      Download & Docs: https://gitlab.com/baumrock/RockPdf
       
      You can combine it easily with RockReplacer: 
      See also a little showcase of the RockPdf module in this thread:
       
    • By bernhard
      WHY?
      This module was built to fill the gap between simple $pages->find() operations and complex SQL queries.
      The problem with $pages->find() is that it loads all pages into memory and that can be a problem when querying multiple thousands of pages. Even $pages->findMany() loads all pages into memory and therefore is a lot slower than regular SQL.
      The problem with SQL on the other hand is, that the queries are quite complex to build. All fields are separate tables, some repeatable fields use multiple rows for their content that belong to only one single page, you always need to check for the page status (which is not necessary on regular find() operations and therefore nobody is used to that).
      In short: It is far too much work to efficiently and easily get an array of data based on PW pages and fields and I need that a lot for my RockGrid module to build all kinds of tabular data.

      Basic Usage

       
      Docs & Download
      https://modules.processwire.com/modules/rock-finder/
      https://gitlab.com/baumrock/RockFinder/tree/master
       
      Changelog
      180810, v1.0.5, basic support for options fields 180528, v1.0.4, add custom select statement option 180516, change sql query method, bump version to 1.0.0 180515, multilang bugfix 180513, beta release <180513, preview/discussion took place here: https://processwire.com/talk/topic/18983-rocksqlfinder-highly-efficient-and-flexible-sql-finder-module/
    • By Thomas Diroll
      Hi guys I'm relatively new to PW and just finished developing a page for a client. I was able to include all necessary functionality using the core fieldtypes but now I it seems that I need to extend them with a custom one. What I need is a simple button, that copies the absolute url (frontend not PW-backend) of the page which is currently edited to the clipboard. As this feature is only needed inside a specific template, I tend to use a custom fieldtype which provides this feature. I've been looking inside the core modules code (eg. FieldtypeCheckbox.module) but I don't really get the structure of it and how its rendered to the admin page. I also didn't find a lot of tutorials covering custom fieldtypes.
      Maybe some of you could give me some tips on how to write a basic custom fieldtype that renders a button which copies the value of
      page->httpUrl() to the clipboard using JS. Thanks!
    • By bernhard
      Some of you might have followed the development of this module here: https://processwire.com/talk/topic/15524-previewdiscussion-rockdatatables/ . It is the successor of "RockDataTables" and requires RockFinder to get the data for the grid easily and efficiently. It uses the open source part of agGrid for grid rendering.
       
      WHY?
      ProcessWire is awesome for creating all kinds of custom backend applications, but where it is not so awesome in my opinion is when it comes to listing this data. Of course we have the built in page lister and we have ListerPro, but none of that solutions is capable of properly displaying large amounts of data, for example lists of revenues, aggregations, quick and easy sorts by the user, instant filter and those kind of features. RockGrid to the rescue 😉 
       
      Features/Highlights:
      100k+ rows Instant (client side) filter, search, sort (different sort based on data type, eg "lower/greater than" for numbers, "contains" for strings) extendable via plugins (available plugins at the moment: fullscreen, csv export, reload, batch-processing of data, column sum/statistics, row selection) all the agGrid features (cell renderers, cell styling, pagination, column grouping etc) vanilla javascript, backend and frontend support (though not all plugins are working on the frontend yet and I don't plan to support it as long as I don't need it myself)  
      Limitations:
      While there is an option to retrieve data via AJAX the actual processing of the grid (displaying, filtering, sorting) is done on the client side, meaning that you can get into troubles when handling really large datasets of several thousands of rows. agGrid should be one of the most performant grid options in the world (see the official example page with a 100k row example) and does a lot to prevent problems (such as virtual row rendering), but you should always have this limitation in mind as this is a major difference to the available lister options that do not have this limitation.
      Currently it only supports AdminThemeUikit and I don't plan to support any other admin theme.
       
      Download: https://gitlab.com/baumrock/RockGrid
      Installation: https://gitlab.com/baumrock/RockGrid/wikis/Installation
      Quikckstart: https://gitlab.com/baumrock/RockGrid/wikis/quickstart
      Further instructions: https://gitlab.com/baumrock/RockGrid/wikis/quickstart#further-instructions
       
      Module status: alpha, License: MIT
      Note that every installation and uninstallation sends an anonymous google analytics event to my google analytics account. If you don't want that feel free to remove the appropriate lines of code before installation/uninstallation.
       
      Contribute:
      You can contribute to the development of this and other modules or just say thank you by
      testing, reporting issues and making PRs at gitlab liking this post buying me a drink: paypal.me/baumrock/5 liking my facebook page: facebook.com/baumrock hiring me for pw work: baumrock.com  
      Support: Please note that this module might not be as easy and plug&play as many other modules. It needs a good understanding of agGrid (and JavaScript in general) and it likely needs some looks into the code to get all the options. Please understand that I can not provide free support for every request here in the forum. I try to answer all questions that might also help others or that might improve the module but for individual requests I offer paid support for 60€ per hour.
       
      Changelog
      180730 support subdir installations 180711 bugfix (naming issue) 180630 alpha realease  
      Use Cases / Examples:
      Colored grid cells, Icons, Links etc. The Grid also has a "batcher" feature built in that helps communicating with the server via AJAX and managing resource intensive tasks in batches:

      Filters, PW panel links and instant reload on panel close:

      You can combine the grid with a chart library like I did with the (outdated) RockDataTables module: