Jump to content
mr-fan

TextformatterGlossary

Recommended Posts

I will share a little texformatter from a actual project for a client.

In my former CMS i had an easy addon where i could preset terms like in a glossary that will replaced in the Wysiwyg fields on every page.

So there are solutions that i know but the all work not that easy like my former used addon.

The title of the glossary_item is used for the termsearch.

This textformatter search for terms in ||termexample|| or ||example term|| and replace them complete. If a term was in ||pipes|| and there was no hit in the glossary entries the pipes will deleted from the term and only the clean value will returned. So no room for wrong user entries like if i used HannCode or something else.

This is great for abbreviations, external- and internal links and could extended for every possible replacement that makes sense like footnotes and so on.

I like the pages concept for content and so i use pages for glossary and simple replacement where a user wanna have it. No autolinking without control, easy use pipes on abbreviations and links and it simple works.

Some explanations from the Github Readme:

Setup

You have to use a pagestructure for the glossary items

  • holder Page for entries template "glossary"
  • glossary items template "glossary_item"

The type of a glossary item could be a abbreviation, a external or internal link. Everything you need could added to the textformatter like more complex stuff, footnotes or other replacements.

Why?

There are working solutions like the great module from Ryan Cramer Autolink in the Profields https://processwire.com/api/modules/profields/autolinks/

But here Users don't could setup easy the terms to replace - this is only ment for webmasters or admins.

There are a module for abbreviations from sunlix https://processwire.com/talk/topic/7467-module-processabbreviate/

But here i only have options for abbreviations and i couln't easy add stuff or replacments i need.

Links

Github: https://github.com/mr-fan/TextformatterGlossary

Example Templates for Import: https://github.com/mr-fan/TextformatterGlossary/blob/master/template-examples.json

Best regards mr-fan

post-2327-0-77553600-1445871522_thumb.pn

  • Like 10

Share this post


Link to post
Share on other sites

Great idea!

If I understand correctly, the module looks for a glossary page with a title that matches the text between the pipe delimiters. I'm wondering about cases where the term in the textarea needs to be slightly different than the glossary page title, for instance if you need to use a plural form of term. Say I have a glossary page for "mouse" but in my textarea I need to say "mice" - could a variation like that still be linked to the glossary item? Perhaps introduce some syntax to manually specify the glossary term for such cases?

Share this post


Link to post
Share on other sites

This could be solved in two ways.

1. create a second term

2. add a field for "plural" and change the textformatter to search in "title" and "plural" field...

would work.

But from my experience you will need specific terms on specific words like ||PW|| or ||contact|| as Link and for abbreviation you have fix terms, too.

regards mr-fan

Share this post


Link to post
Share on other sites

Hi @mr-fan

Your module sounds to be exactly what I'm looking for :). Unfortunately, I'm not sure I understand what to do. I tried to import your example template but ran many errors (see screenshot). I'm using PW 3.0.24.

Do I can just create a "page_link" field in the glossary_term template (since I will just use this one)? Do I need something else particular? Can I add another field like summary to have a more longer text?

Also, if want to output the list of all terms on the glossary page, I just used the template/field as we normally do? 

Thanks

Mel

Sélection_103.png

Share this post


Link to post
Share on other sites

Oh i forgot the used fields you need...a headline field, a page select and a url field for internal and external links - so give this import file a try:

https://github.com/mr-fan/TextformatterGlossary/blob/master/fields-example.json

the whole system is very flexible since we use pages.

for now there 3 different types of the glossary there that will be replaced if you look at the code it is very simple to know whats going on behind:

//set the replacement depending from the item type
switch ($entry->glossary_type) {
   case '1': //abbr
        $replacement = '<abbr title="' . $entry->headline . '">' . $term . '</abbr>';
        break;
   case '2': //external link
        $replacement = '<a rel="help" target="blank" href="' . $entry->extern_link . '" data-original-title="' . $entry->headline . '"><span class="fa-globe" aria-hidden="true"></span> ' . $term . '</a>';
        break;
   case '3': //internal link
        //internal link need to get the url
        $internLink  = wire('pages')->get("$entry->page_link");
        $replacement = '<a rel="help" href="' . $internLink->url . '" data-original-title="' . $entry->headline . '">' . $term . '</a>';
        break;
   default:
        $replacement = $term;
}

it yould be possible to upscale the textformatter to use for footnotes, remarks or something else...;)

regards mr-fan

Share this post


Link to post
Share on other sites

Hi,

I progress! I created the fields. It seems to have to have a little inconsistency between "glossar" and "glossary" but I thinks everything is fine now. But it doesn't seems to works. If I understand correctly, if the term is not created, it should at least remove the ||. But even if the glossary_item "test" exists, nothing seems to happen. Do you have an idea of what going wrong?

Thanks

PS Evidently, module is correctly installed, there is no error. I'm using PW 3.0.28

Sélection_104.png

Sélection_105.png

Sélection_106.png

Share this post


Link to post
Share on other sites

Hmm all looks good so far.

One question - have you set the Textformatter on the field you wanna use this?

  • Like 2

Share this post


Link to post
Share on other sites

oh my... :blush: Still have so much thing to learn...

Thanks it works now.

  • Like 1

Share this post


Link to post
Share on other sites
On 27/10/2015 at 4:02 AM, mr-fan said:

I like the pages concept for content and so i use pages for glossary and simple replacement where a user wanna have it. No autolinking without control, easy use pipes on abbreviations and links and it simple works.

I get the reason for having manual control of where links/abbreviations appear, but what do you think about adding an option where terms are replaced automatically? It would be nice to give the user the ability to add new terms to the glossary without having to go through all their pages looking for where the term appears and adding the ||term|| syntax manually.

Share this post


Link to post
Share on other sites

For this proposal Ryan build a great module that works really good:

https://processwire.com/api/modules/profields/autolinks/

From my point of view Ryan is right on his choice to let only admins set the terms if an automatic is running...

The mixture of user defined terms and automatic replacement could be very dangerous.

But you could simple fork and change the module and switch from the ||regex|| to a exact search for the terms and replace them automagical.....since i'm a "second hand" webdev + living on a farm in south germany = summertime is some harvest and less time for the desk ;)
best regards mr-fan

 

  • 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 MoritzLost
      This is a new module that provides a simple solution to clearing all your cache layers at once, and an extensible interface to perform various cache-related actions.
      The simple motivation behind this module was that I was tired of manually clearing caches in several places after deploying a change on a live site. The basic purpose of this module is a simple Clear all caches link in the Setup menu which clears out all caches, no matter where they hide. You can customize what exactly the module does through it's configuration menu:
      Expire or delete all cache entries in the database, or selectively clear caches by namespace ($cache API) Clear the the template render cache. Clear out specific folders inside your site's cache directory (/site/assets/cache) Refresh version strings for static assets to bust client-side browser caches (this requires some setup, see the full documentation for details). This is the basic function of the module. However, you can also add different cache management action through the API and execute them through the module's interface. For this advanced usage, the module provides:
      An interface to see all available cache actions and execute them. A system log and logging output on the module page to see verify what the module is doing. A CacheControlTools class with utility functions to clear out different caches. An API to add cache actions, execute them programmatically and even modify the default action. Permission management, allowing you granular control over which user roles can execute which actions. The complete documentation can be found in the module's README.
      Beta release
      Note that I consider this a Beta release. Since the module is relatively aggressive in deleting some caches, I would advise you to install in on a test environment before using it on a live site.
      Let me know if you're getting any errors, have trouble using the module or if you have suggestions for improvement!
      In particular, can someone let me know if this module causes any problems with the ProCache module? I don't own or use it, so I can't check. As far as I can tell, ProCache uses a folder inside the cache directory to cache static pages, so my module should be able to clear the ProCache site cache as well, I'd appreciate it if someone can test that for me.
      Future plans
      If there is some interest in this, I plan to expand this to a more general cache management solution. I particular, I would like to add additional cache actions. Some ideas that came to mind:
      Warming up the template render cache for publicly accessible pages. Removing all active user sessions. Let me know if you have more suggestions!
      Links
      https://github.com/MoritzLost/ProcessCacheControl ProcessCacheControl in the Module directory

    • By joshua
      This module is (yet another) way for implementing a cookie management solution.
      Of course there are several other possibilities:
      - https://processwire.com/talk/topic/22920-klaro-cookie-consent-manager/
      - https://github.com/webmanufaktur/CookieManagementBanner
      - https://github.com/johannesdachsel/cookiemonster
      - https://www.oiljs.org/
      - ... and so on ...
      In this module you can configure which kind of cookie categories you want to manage:

      You can also enable the support for respecting the Do-Not-Track (DNT) header to don't annoy users, who already decided for all their browsing experience.
      Currently there are four possible cookie groups:
      - Necessary (always enabled)
      - Statistics
      - Marketing
      - External Media
      All groups can be renamed, so feel free to use other cookie group names. I just haven't found a way to implement a "repeater like" field as configurable module field ...
      When you want to load specific scripts ( like Google Analytics, Google Maps, ...) only after the user's content to this specific category of cookies, just use the following script syntax:
      <script type="optin" data-type="text/javascript" data-category="statistics" data-src="/path/to/your/statistic/script.js"></script> <script type="optin" data-type="text/javascript" data-category="marketing" data-src="/path/to/your/mareketing/script.js"></script> <script type="optin" data-type="text/javascript" data-category="external_media" data-src="/path/to/your/external-media/script.js"></script> <script type="optin" data-type="text/javascript" data-category="marketing">console.log("Inline scripts are also working!");</script> The type has to be "optin" to get recognized by PrivacyWire, the data-attributes are giving hints, how the script shall be loaded, if the data-category is within the cookie consents of the user. These scripts are loaded asynchronously after the user made the decision.
      If you want to give the users the possibility to change their consent, you can use the following Textformatter:
      [[privacywire-choose-cookies]] It's planned to add also other Textformatters to opt-out of specific cookie groups or delete the whole consent cookie.
      You can also add a custom link to output the banner again with a link / button with following class:
      <a href="#" class="privacywire-show-options">Show Cookie Options</a> <button class="privacywire-show-options">Show Cookie Options</button> This module is still in development, but we already use it on several production websites.
      You find it here: https://github.com/blaueQuelle/privacywire/tree/master
      Download: https://github.com/blaueQuelle/privacywire/archive/master.zip
      I would love to hear your feedback 🙂
      Edit: Updated URLs to master tree of git repo
       
    • By David Karich
      Admin Page Tree Multiple Sorting
      ClassName: ProcessPageListMultipleSorting
      Extend the ordinary sort of children of a template in the admin page tree with multiple properties. For each template, you can define your own rule. Write each template (template-name) in a row, followed by a colon and then the additional field names for sorting.
      Example: All children of the template "blog" to be sorted in descending order according to the date of creation, then descending by modification date, and then by title. Type:
      blog: -created, -modified, title  Installation
      Copy the files for this module to /site/modules/ProcessPageListMultipleSorting/ In admin: Modules > Check for new modules. Install Module "Admin Page Tree Multible Sorting". Alternative in ProcessWire 2.4+
      Login to ProcessWire backend and go to Modules Click tab "New" and enter Module Class Name: "ProcessPageListMultipleSorting" Click "Download and Install"   Compatibility   I have currently tested the module only under PW 2.6+, but think that it works on older versions too. Maybe someone can give a feedback.     Download   PW-Repo: http://modules.processwire.com/modules/process-page-list-multiple-sorting/ GitHub: https://github.com/FlipZoomMedia/Processwire-ProcessPageListMultipleSorting     I hope someone can use the module. Have fun and best regards, David
    • By dimitrios
      Hello,
      this module can publish content of a Processwire page on a Facebook page, triggered by saving the Processwire page.
      To set it up, configure the module with a Facebook app ID, secret and a Page ID. Following is additional configuration on Facebook for developers:
      Minimum Required Facebook App configuration:
      on Settings -> Basics, provide the App Domains, provide the Site URL, on Settings -> Advanced, set the API version (has been tested up to v3.3), add Product: Facebook Login, on Facebook Login -> Settings, set Client OAuth Login: Yes, set Web OAuth Login: Yes, set Enforce HTTPS: Yes, add "https://www.example.com/processwire/page/" to field Valid OAuth Redirect URIs. This module is configurable as follows:
      Templates: posts can take place only for pages with the defined templates. On/Off switch: specify a checkbox field that will not allow the post if checked. Specify a message and/or an image for the post.
      Usage
      edit the desired PW page and save; it will post right after the initial Facebook log in and permission granting. After that, an access token is kept.
       
      Download
      PW module directory: http://modules.processwire.com/modules/auto-fb-post/ Github: https://github.com/kastrind/AutoFbPost   Note: Facebook SDK for PHP is utilized.


×
×
  • Create New...