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 20
  • 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

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 3

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 Anssi
      A simple module to enable easy navigation between the public and the admin side of the site. After installation a green bar will appear to the upper side of the screen, containing a few navigation elements and displaying the PW version number.
      Heavily inspired by @apeisa's great AdminBar (Thanks!). I needed a bit simpler tool for my projects and as a result, this was made. Available on GitHub .

    • By Sebi
      I've created a small module which lets you define a timestamp after which a page should be accessible. In addition you can define a timestamp when the release should end and the page should not be accessable any more.
      Github: https://github.com/Sebiworld/PageAccessReleasetime
      Usage
      PageAccessReleasetime can be installed like every other module in ProcessWire. Check the following guide for detailed information: How-To Install or Uninstall Modules
      After that, you will find checkboxes for activating the releasetime-fields at the settings-tab of each page. You don't need to add the fields to your templates manually.
      Check e.g. the checkbox "Activate Releasetime from?" and fill in a date in the future. The page will not be accessable for your users until the given date is reached.
      If you have $config->pagefileSecure = true, the module will protect files of unreleased pages as well.
      How it works
      This module hooks into Page::viewable to prevent users to access unreleased pages:
      public function hookPageViewable($event) { $page = $event->object; $viewable = $event->return; if($viewable){ // If the page would be viewable, additionally check Releasetime and User-Permission $viewable = $this->canUserSee($page); } $event->return = $viewable; } To prevent access to the files of unreleased pages, we hook into Page::isPublic and ProcessPageView::sendFile.
      public function hookPageIsPublic($e) { $page = $e->object; if($e->return && $this->isReleaseTimeSet($page)) { $e->return = false; } } The site/assets/files/ directory of pages, which isPublic() returns false, will get a '-' as prefix. This indicates ProcessWire (with activated $config->pagefileSecure) to check the file's permissions via PHP before delivering it to the client.
      The check wether a not-public file should be accessable happens in ProcessPageView::sendFile. We throw an 404 Exception if the current user must not see the file.
      public function hookProcessPageViewSendFile($e) { $page = $e->arguments[0]; if(!$this->canUserSee($page)) { throw new Wire404Exception('File not found'); } } Additionally we hook into ProcessPageEdit::buildForm to add the PageAccessReleasetime fields to each page and move them to the settings tab.
      Limitations
      In the current version, releasetime-protected pages will appear in wire('pages')->find() queries. If you want to display a list of pages, where pages could be releasetime-protected, you should double-check with $page->viewable() wether the page can be accessed. $page->viewable() returns false, if the page is not released yet.
      If you have an idea how unreleased pages can be filtered out of ProcessWire selector queries, feel free to write an issue, comment or make a pull request!
    • By David Karich
      Thanks to the great Pro module "RepeaterMatrix" I have the possibility to create complex repeater items. With it I have created a quite powerful page builder. Many different content modules, with many more possible design options. The RepeaterMatrix module supports the cloning of items, but only within the same page. Now I often have the case that very design-intensive pages and items are created. If you want to use this module on a different page (e.g. in the same design), you have to rebuild each item manually every time.
      With this proof of concept I have created a module which adds the feature to copy a repeater item to the clipboard so that you can paste this item to another page with the same repeater field. The module has been developed very rudimentarily so far. It is currently not possible to copy nested items. There is also no check of Min/Max. You can also only copy items that have the same field on different pages. And surely you can solve all this more elegantly with AJAX. But personally I lack the deeper understanding of the repeaters. Also missing on the Javascript side are event triggers for the repeaters, which would make it easier. Like e.g. RepeaterItemInitReady or similar.
      it would be great if @ryan would implement this functionality in the core of RepeaterMatrix. I think he has better ways to implement this. Or what do you think, Ryan?
      Everybody is welcome to work on this module and improve it, if it should not be integrated into the matrix core. Therefore I put it for testing and as download on GitHub: https://github.com/FlipZoomMedia/InputfieldRepeaterMatrixDublicate
      You can best see the functionality in the screencast: 
       
    • By anderson
      Hi,
      Please take a look at this:
      https://templatemag.com/demo/Good/
      The upper nav bar, including dropdowns like "pages" and "portfolios", what do you call this whole thing? At first I guess it's called "dropdown nav bar", but seems not.
      AND of course, what's the simplest way/module to achieve this in PW?
      Thanks in advance.
    • By Sebi2020
      Hey, I'm new and I created a simple module for tagging pages because I didn't found a module for it (sadly this is not a core feature). This module is licensed under the GPL3 and cames with absolutly no warranty at all. You should test the module before using it in production environments. Currently it's an alpha release. if you like the module or have ideas for improvements feel free to post a comment. Currently this fieldtype is only compatible with the Inputfield I've created to because I haven't found  an Inputfield yet, that returns arrays from a single html input.
      Greetings Sebi2020
      FieldtypeTags.zip.asc
      InputfieldTagify.zip
      InputfieldTagify.zip.asc
      FieldtypeTags.zip