Jump to content
sunlix

Module: ProcessAbbreviate

Recommended Posts

Hi Guys,

today I want to introduce my first module for ProcessWire: ProcessAbbreviate

The module basically hooks the save event of pages and extract all marked up abbreviations in textareas.

With the shipped CKEditor plugin comes the main improvement in supporting faster marking up abbreviations.

The plugin suggest explanations based on previously extracted abbreviations.

On the created setup page, all abbreviations can be managed.

Also you can predefine your common used abbreviations to prime the suggestion list.

The module can be found at GitHub: https://github.com/sunlix/ProcessAbbreviate

Feel free to try it out.

Any hints and improvements are welcome.

regards,

Sven

Edited by sunlix
  • Like 9

Share this post


Link to post
Share on other sites

Hey sunlix, welcome to the forums.

Really cool first post!

Reading a bit through the code on Github makes me "want to try it out" :)

(unfortunately I haven't enough time now, but will come back to this soon)

Share this post


Link to post
Share on other sites

Installed it and got an error on windows WAMP:

Compile Error: require_once(): Failed opening required '' (include_path='.;C:\php\pear') (line 968 of E:\wamp\www\pwdev\wire\core\Modules.php) 
 
i have no pear installed.
 
After installing PEAR it works.

Share this post


Link to post
Share on other sites

Hi,

sorry for the delay - I was off for some vacation.

Which ProcessWire and PHP version did you used on your WAMP?

Didn't know about some pear specials I am using, yet^^

regards

Share this post


Link to post
Share on other sites

Hi Guys,

at this night I've pushed some changes to my master branch of ProcessAbbreviate.

The following features are included in version 0.2.1

  • Support for the language attribute of <abbr/>
  • Configurable auto mark up feature
  • Bug fixes

Support for the language attribute of <abbr/>

I've altered the database table to save the language attribute for some kind of multi language support.

This attribute is usable for screen readers to change pronunciation for the given abbreviation.

Additional its usable in multi language systems for better/saver language handling.

Configurable auto mark up feature

Well, I would call it experimental. (It have to activate manually)

I've just done some basic tests in auto marking up abbreviations.

I would be happy to get some feedback if it could be more precise or so. :-)

If you have two or more abbreviations with the same abbreviation (text), the first abbreviation saved in the database will be auto marked up.

So this feature will ever be a little support for marking up abbreviations, but you have to check these abbreviations on your own to be secure that the right abbreviation is marked up.

Bug fixes

There was a bug by uninstalling the module Abbreviate which did not delete the admin page created by installing this module.

(thanks teppo)

So I hope you enjoy this additions and give ProcessAbbreviate a try. :-)

Any feedback are welcome!

regards,

Sven

  • Like 1

Share this post


Link to post
Share on other sites

Ho folks,

I've a new release 0.3.1 for my module ProcessAbbreviate.

The following changes are included in version 0.3.1

  • Proper Attribute extraction on each found <abbr>
  • Better CKEditor plugin

Proper Attribute extraction on each found <abbr>

The latest version has a better attribute extraction for found <abbr> tags.

Now there should be no unexpected titles or language extractions any more.

I've ran into a special one with the latest ProcessWire dev branch where titles were not extracted correctly cause the presence of a xml:lang attribute.

Better CKEditor plugin

The included CKEditor plugin got a cleaned up code and fixed by selecting your abbreviation with defined language attributes.

Now the behavior should be as it should :D

Let me know if anyone has some trouble with this release. :)

Your feedback are welcome. :)

regards,

Sven

Share this post


Link to post
Share on other sites

Hi,

I've published Version 0.4.1 of Abbreviate.

The following changes are included.

  • fixed #1 possible value overwriting with empty strings
  • Better auto mark up

fixed #1 possible value overwriting with empty strings

It is no longer allowed to set a empty String on the language attribute if there is a value set.

This fixes bug #1 in the issue tracker.

For the same behavior I've edited the code line also for the abbreviation text.

Better auto mark up

I've removed the right word boundary check, because german abbreviation style like z.B. or usw. couldn't found automatically cause the dot character is a non word character.

Is there any developer with regex knowledge you can support me in creating a better regex for the auto mark up feature?

Currently it feels a little bit rudimentary and not finished yet.

I use this feature by myself and it works in most cases, but I think there are certain edge cases. :)

The new version is pushed to GitHub and will be available soon via the system updater.

regards,

Sven

  • Like 1

Share this post


Link to post
Share on other sites

Hello @sunlix

I get the following error after activation of the automatic markup of abbreviations.

Screenshot_25.jpg.9ea6122c01c67b9c926bd67977f0b94f.jpg

My site is multilingual and I use the lates PW dev version. Maybe a namespace/file compiler problem?

Best regards

Share this post


Link to post
Share on other sites

Hi @Juergen

I've tagged version 1.0.1 to solve your error.

This could be happen if composer was not used to manage modules.

Share this post


Link to post
Share on other sites

hmmm can you look at the top of your referenced file if this line appears?

if(!class_exists('Abbreviation', false)) require_once(__DIR__ .'/Abbreviation.php');

 

  • Like 1

Share this post


Link to post
Share on other sites

No, this piece of code doesnt exist in the module file. I have added it at the top after the namespace and now it works.:) Thanks!!!!

If a problem occurs once more I will post it here.

Best regards

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 Gadgetto
      SnipWire - Snipcart integration for ProcessWire
      Snipcart is a powerful 3rd party, developer-first HTML/JavaScript shopping cart platform. SnipWire is the missing link between Snipcart and the content management framework ProcessWire.
      With SnipWire, you can quickly turn any ProcessWire site into a Snipcart online shop. The SnipWire plugin helps you to get your store up and running in no time. Detailed knowledge of the Snipcart system is not required.
      SnipWire is free and open source licensed under Mozilla Public License 2.0! A lot of work and effort has gone into development. It would be nice if you could donate an amount to support further development:

      Status update links (inside this thread) for SnipWire development
      2020-07-03 -- SnipWire 0.8.7 (beta) released! Fixes some small bugs and adds an indicator for TEST mode 2020-04-06 -- SnipWire 0.8.6 (beta) released! Adds support for Snipcart subscriptions and also fixes some problems 2020-03-21 -- SnipWire 0.8.5 (beta) released! Improves SnipWires webhooks interface and provides some other fixes and additions 2020-03-03 -- SnipWire 0.8.4 (beta) released! Improves compatibility for Windows based Systems. 2020-03-01 -- SnipWire 0.8.3 (beta) released! The installation and uninstallation process has been heavily revised. 2020-02-08 -- SnipWire 0.8.2 (beta) released! Added a feature to change the cart and catalogue currency by GET, POST or SESSION param 2020-02-03 -- SnipWire 0.8.1 (beta) released! All custom classes moved into their own namespaces. 2020-02-01 -- SnipWire is now available via ProcessWire's module directory! 2020-01-30 -- SnipWire 0.8.0 (beta) first public release! (module just submitted to the PW modules directory) 2020-01-28 -- added Custom Order Fields feature (first SnipWire release version is near!) 2020-01-21 -- Snipcart v3 - when will the new cart system be implemented? 2020-01-19 -- integrated taxes provider finished (+ very flexible shipping taxes handling) 2020-01-14 -- new date range picker, discount editor, order notifiactions, order statuses, and more ... 2019-11-15 -- orders filter, order details, download + resend invoices, refunds 2019-10-18 -- list filters, REST API improvements, new docs platform, and more ... 2019-08-08 -- dashboard interface, currency selector, managing Orders, Customers and Products, Added a WireTabs, refinded caching behavior 2019-06-15 -- taxes provider, shop templates update, multiCURL implementation, and more ... 2019-06-02 -- FieldtypeSnipWireTaxSelector 2019-05-25 -- SnipWire will be free and open source Plugin Key Features
      Fast and simple store setup Full integration of the Snipcart dashboard into the ProcessWire backend (no need to leave the ProcessWire admin area) Browse and manage orders, customers, discounts, abandoned carts, and more Multi currency support Custom order and cart fields Process refunds and send customer notifications from within the ProcessWire backend Process Abandoned Carts + sending messages to customers from within the ProcessWire backend Complete Snipcart webhooks integration (all events are hookable via ProcessWire hooks) Integrated taxes provider (which is more flexible then Snipcart own provider) Useful Links
      SnipWire in PW modules directory SnipWire Docs (please note that the documentation is a work in progress) SnipWire @GitHub (feature requests and suggestions for improvement are welcome - I also accept pull requests) Snipcart Website  

       
      ---- INITIAL POST FROM 2019-05-25 ----
       
    • By Sten
      Hello
      Till now I hacked something with the twig template but it works no more with new PW versions so I look forward to create a module. I am working on a site in multiple languages : French, English, Italian, German, Spanish, Portuguese, Hebrew, Russian. The new posts are entered in any language with a field for language. Till now, I got twig files to get the translations with constants defined for each part of the pages.
      So I'd like to create a module to include theses files added according to the url /fr/en/...
      Have you some observations to do before I begin about the direction to take ?
      Thank you
    • By ukyo
      Mystique Module for ProcessWire CMS/CMF
      Github repo : https://github.com/trk/Mystique
      Mystique module allow you to create dynamic fields and store dynamic fields data on database by using a config file.
      Requirements
      ProcessWire 3.0 or newer PHP 7.0 or newer FieldtypeMystique InputfieldMystique Installation
      Install the module from the modules directory:
      Via Composer:
      composer require trk/mystique Via git clone:
      cd your-processwire-project-folder/ cd site/modules/ git clone https://github.com/trk/Mystique.git Module in live reaction with your Mystique config file
      This mean if you remove a field from your config file, field will be removed from edit screen. As you see on youtube video.
      Using Mystique with your module or use different configs path, autoload need to be true for modules
      Default configs path is site/templates/configs/, and your config file name need to start with Mystique. and need to end with .php extension.
      Adding custom path not supporting anymore !
      // Add your custom path inside your module class`init` function, didn't tested outside public function init() { $path = __DIR__ . DIRECTORY_SEPARATOR . 'configs' . DIRECTORY_SEPARATOR; Mystique::add($path); } Mystique module will search site/modules/**/configs/Mystique.*.php and site/templates/Mystique.*.php paths for Mystique config files.
      All config files need to return a PHP ARRAY like examples.
      Usage almost same with ProcessWire Inputfield Api, only difference is set and showIf usage like on example.
      <?php namespace ProcessWire; /** * Resource : testing-mystique */ return [ 'title' => __('Testing Mystique'), 'fields' => [ 'text_field' => [ 'label' => __('You can use short named types'), 'description' => __('In file showIf working like example'), 'notes' => __('Also you can use $input->set() method'), 'type' => 'text', 'showIf' => [ 'another_text' => "=''" ], 'set' => [ 'showCount' => InputfieldText::showCountChars, 'maxlength' => 255 ], 'attr' => [ 'attr-foo' => 'bar', 'attr-bar' => 'foo' ] ], 'another_text' => [ 'label' => __('Another text field (default type is text)') ] ] ]; Example:
      site/templates/configs/Mystique.seo-fields.php <?php namespace ProcessWire; /** * Resource : seo-fields */ return [ 'title' => __('Seo fields'), 'fields' => [ 'window_title' => [ 'label' => __('Window title'), 'type' => Mystique::TEXT, // or InputfieldText 'useLanguages' => true, 'attr' => [ 'placeholder' => __('Enter a window title') ] ], 'navigation_title' => [ 'label' => __('Navigation title'), 'type' => Mystique::TEXT, // or InputfieldText 'useLanguages' => true, 'showIf' => [ 'window_title' => "!=''" ], 'attr' => [ 'placeholder' => __('Enter a navigation title') ] ], 'description' => [ 'label' => __('Description for search engines'), 'type' => Mystique::TEXTAREA, 'useLanguages' => true ], 'page_tpye' => [ 'label' => __('Type'), 'type' => Mystique::SELECT, 'options' => [ 'basic' => __('Basic page'), 'gallery' => __('Gallery'), 'blog' => __('Blog') ] ], 'show_on_nav' => [ 'label' => __('Display this page on navigation'), 'type' => Mystique::CHECKBOX ] ] ]; Searching data on Mystique field is limited. Because, Mystique saving data to database in json format. When you make search for Mystique field, operator not important. Operator will be changed with %= operator.
      Search example
      $navigationPages = pages()->find('my_mystique_field.show_on_nav=1'); $navigationPages = pages()->find('my_mystique_field.page_tpye=gallery');
    • By Robin S
      This is a module I made as an experiment a while ago and never got around to releasing publicly. At the time it was prompted by discussions around using Repeater fields for "page builder" purposes, where the depth feature could possibly be used for elements that would be nested inside other elements. I thought it would be useful to enforce some depth rules and translate the depth data into a multi-dimensional array structure.
      I'm not using this module anywhere myself but maybe it's useful to somebody.
      Repeater Depth Helper
      This module does two things relating to Repeater fields that have the "Item depth" option enabled:
      It enforces some depth rules for Repeater fields on save. Those rules are:
      The first item must have a depth of zero. Each item depth must not be more than one greater than previous item depth. It provides a RepeaterPageArray::getDepthStructure helper method that returns a nested depth structure for a Repeater field value.
      Helper method
      The module adds a RepeaterPageArray::getDepthStructure method that returns a multi-dimensional array where the key is the page ID and the value is an array of nested "child" items, or null if there are no nested children.
      Example

      The module doesn't make any assumptions about how you might want to use the depth structure array, but here is a way you might use it to output a nested unordered list.
      // Output a nested unordered list from a depth structure array function outputNestedList($depth_structure, $repeater_items) { $out = "<ul>"; foreach($depth_structure as $page_id => $nested_children) { $out .= "<li>" . $repeater_items->get("id=$page_id")->title; // Go recursive if there are nested children if(is_array($nested_children)) $out .= outputNestedList($nested_children, $repeater_items); $out .= "</li>"; } $out .= "</ul>"; return $out; } $repeater_items = $page->my_repeater; $depth_structure = $repeater_items->getDepthStructure(); echo outputNestedList($depth_structure, $repeater_items);
       
      https://github.com/Toutouwai/RepeaterDepthHelper
      https://modules.processwire.com/modules/repeater-depth-helper/
    • By MoritzLost
      Cacheable Placeholders
      This module allows you to have pieces of dynamic content inside cached output. This aims to solve the common problem of having a mostly cacheable site, but with pieces of dynamic output here and there.  Consider this simple example, where you want to output a custom greeting to the current user:
      <h1>Good morning, <?= ucfirst($user->name) ?></h1> This snippet means you can't use the template cache (at least for logged-in users), because each user has a different name. Even if 99% of your output is static, you can only cache the pieces that you know won't include this personal greeting. A more common example would be CSRF tokens for HTML forms - those need to be unique by definition, so you can't cache the form wholesale.
      This module solves this problem by introducing cacheable placeholders - small placeholder tokens that get replaced during every request. The replacement is done inside a Page::render hook so it runs during every request, even if the response is served from the template cache. So you can use something like this:
      <h1>Good morning, {{{greeting}}}</h1> Replacement tokens are defined with a callback function that produces the appropriate output and added to the module through a simple hook:
      // site/ready.php wire()->addHookAfter('CachePlaceholders::getTokens', function (HookEvent $e) { $tokens = $e->return; $tokens['greeting'] = [ 'callback' => function (array $tokenData) { return ucfirst(wire('user')->name); } ]; $e->return = $tokens; }); Tokens can also include parameters that are parsed and passed to the callback function. There are more fully annotated examples and step-by-step instructions in the README on Github!
      Features
      A simple and fast token parser that calls the appropriate callback and runs automatically. Tokens may include multiple named or positional parameters, as well as multi-value parameters. A manual mode that allows you to replace tokens in custom pieces of cached content (useful if you're using the $cache API). Some built-in tokens for common use-cases: CSRF-Tokens, replacing values from superglobals and producing random hexadecimal strings. The token format is completely customizable, all delimiters can be changed to avoid collisions with existing tag parsers or template languages. Links
      Github Repository & documentation Module directory If you are interested in learning more, the README is very extensive, with more usage examples, code samples and usage instructions!
×
×
  • Create New...