Recommended Posts

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.

Edited by Mike Rockett
0.4.0
  • Like 16

Share this post


Link to post
Share on other sites

Edit: Feature has been removed. See next post.

Bumped to 0.1.1 and added styles():

<?= $modules->get('TextformatterTypographer')->styles(); ?>

Outputs the following default style-set:

span.caps{font-size:96%}
span.numbers{font-size:96%}
span.dquo{margin-left:-.41em}
span.squo{margin-left:-.06em}

To configure this, add a config array as the first parameter. For caps and numbers, Typographer will detect if you're specifying a string or integer-based value and name the property accordingly:

<?= $modules->get('TextformatterTypographer')->styles([
	'caps' => 'Charter SC', // some fonts don't render well when their font-size is changed, so using a small caps font is better.
	'numbers' => 'Charter SC',
	'dquo' => '-.29em', // depends on your font
]); ?>

This outputs the following:

span.caps{font-family:'Charter SC'}
span.numbers{font-family:'Charter SC'}
span.dquo{margin-left:-.29em}
span.squo{margin-left:-.06em}

Or, you could well use your own stylesheet.

Also, I haven't done anything about ampersands. Not many people style those, and so there's no sensible default.

(GitHub)

  • Like 2

Share this post


Link to post
Share on other sites

Bumped to 0.2.0-beta:

  • Switch from the old PHP Typography library to the newer, more frequently updated library found at wp-Typography. This adds several features that are now being used in the module. Some features are not working correctly for me, and so I have excluded them. Soon, I'll do a complete tear-down to see what works and what doesn't.
  • Config no longer allows the textformatter to be disabled. If you want to turn it off, rather remove it from your field.
  • Config no longer allows to reset to defaults. A different implementation of this may be added in the future, if deemed required.
  • Stylesheet is no longer provided as a function for the purposes of not being opinionated. There is, however, a stylesheet in the module's directory, which can be used as a basis for your main stylesheet.
  • You will also notice that the stylesheet references new classes. Due to the fact that this fork of PHP-Typography uses hanging punctuation, new classes have been added. However, they retained the original naming for single and double initial quotes. As this is a new module for PW, I thought it sensible to change these names. All the new class names are in the stylesheet, and also in the Typographer subclass.
  • Like 1

Share this post


Link to post
Share on other sites

Important: The behind-the-scenes library can be quite resource heavy. As mentioned in the module's configuration, it's highly recommended that you cache your templates or use ProCache. Users of the WordPress plugin are also advised to use Super Cache, and so there's not much I can do about this.

  • Like 1

Share this post


Link to post
Share on other sites

In light of the above, I've been working on a port of Typset from JS to PHP: https://github.com/mikerockett/php-typeset

 

before_after.gif

 

It doesn't include hyphenation, but does add features not found in the original JS version. It's currently in alpha, and I'll make a Textformatter for it when it's stable.

I haven't done benchmarking between Typography and Typeset, but I can already feel that Typeset is faster.

Sensible (common) defaults are set.

If you're keen to have a look, please let me know what you think.

?

  • Like 5

Share this post


Link to post
Share on other sites

So the current maintainer of wp-Typography and I have been having a discussion about performance, and I've since done some benchmarking. It appears that Typeset is actually slower, but it is due to two modules: small caps and hanging punctuation. These two modules appear to be very resource intensive. I think Typeset felt faster because they were being used in different contexts - one with ProcessWire and one without (Typeset doesn't have a text-formatter yet).

If you're interested, here's the discussion (benchmarks included).

Share this post


Link to post
Share on other sites

In response to Teppo's Weekly #139:

Thanks for the features; much appreciated! For the most part, web typography is kinda new to me. I've noticed in the past, but never really thought much about it (most people don't). So playing around with all of this is quite interesting. There is still much for me to learn in terms of best practice, and I want to see where Typeset can be improved. Whilst I really like PHP Typography (specifically the fork of it found in wp-Typography), I'd like to be able to use Typeset as a daily driver once performance has been improved as much as possible.

Also, just a note about the typography textformatter: it's only slow when hyphenation is enabled; that appears to be the case from experiencing the difference on my blog. Nonetheless, it's always recommended to cache your output for better performance. No amount of performance-improvements to the modules will save the time that caching will.

  • Like 2

Share this post


Link to post
Share on other sites

Just wanted to stop by here and say thanks for this module, I'm hoping to use it on a lot of sites, once I can work out how to fix the possible issue described below...

I have 2 projects that i was using it on, and for me it was working fine on all my browsers, 5-6 laptops and 2 desktops; the snafu that I ran into was that users on some Safari versions, both on iPad and desktop were reporting google fonts looking garbled and corrupted.

I did a lot of troubleshooting, without really considering that this textformatter could be the culprit, but having just got off the phone with a Safari 9.1.3 user, they confirmed that the google fonts appeared all fixed and the problem solved once i removed the textformatter...

If you want me to report this on Github, i can do that, just wanted to post here, in case anyone else runs into this problem (and it is probably only seen by that minority of users who are using Safari, on a specific OS X, possibly 10.9.5); it does work and look fine on Chrome and Firefox...

Share this post


Link to post
Share on other sites

@Macrura - Thanks for bringing it up. Interesting that the fonts would look garbled - could you perhaps post a screenie of what that looks like? That aside, it's more than likely something I can't solve as it's unrelated to the textformatter itself, and more related to PHP Typography. However, I can't see how it would cause text to be garbled, so a screenie would help loads.

Share this post


Link to post
Share on other sites

Yes thanks - didn't mean to imply that the module would be able to solve this... here is an example screenshot:

 

Screen_Shot_2017-01-23_at_10_20_40_AM.jpg

Share this post


Link to post
Share on other sites
6 hours ago, Macrura said:

didn't mean to imply that the module would be able to solve this...

Sure, but one never knows - I would have liked it to. ;-)

So that seems really odd. At first I thought it was the diacritics feature, but those mangled words don't have any diacritic alternates. It could perhaps by hyphenation, but my gut tells me it's not very likely. Nonetheless, try turning that off by removing the language code from the hyphenation field in config. Failing which, perhaps me seeing the compiled source code would help - I could then investigate myself or discuss with the author. Also, what font is that? Raleway?

Share this post


Link to post
Share on other sites

the problem here is that i can't reproduce this issue, it was reported to me by some people who sent me screenshots; so i can't get source code, and i can't really test it, until i can find a mac running exactly the same OS and Safari version;

those same users said the problem didn't occur on Firefox; and the one user who i had on the phone told me the problem immediately fixed itself when i removed that textformatter...

it is possible i may have had something mis-configured with the language code or that removing that would also have fixed it.

Font is Raleway...

I will probably have to setup a local install next week in order to test the language code setting (both these sites are live now)...

Share this post


Link to post
Share on other sites

actually i was wrong about the source code - that is all cached by pro cache, so it would be the same for everyone, unless the generated source under Safari was somehow different based on some set of conditions; i did test it with various ways of loading the google fonts (regular script tag, webfont loader etc, and those didn't seem to make any difference).

One of the sites will be live tomorrow, the other is here: https://www.chestnutridgetennis.com/

thanks - and sorry for incoherence, getting late here in NY.

Share this post


Link to post
Share on other sites

@Macrura - thanks, and no stress. Will see what I can find in the meantime.

As a side note, there is also Typeset, which I ported over from Typeset.js. However, there are a few bugs relating to the HTML parser, so there won't be a textformatter until such time as those are all ironed out.

Share this post


Link to post
Share on other sites

I totally should have reviewed the FAQ:

Quote

There is a bug in the shipped Safari 9 that results in strange characters being rendered when both ligatures and soft hyphens appear on the same line. (The bug is only triggered when the font actually supports ligatures, e.g. with Open Sans.)

Fortunately, adding the following line to your CSS fixes the font rendering and preserves ligatures:

1
2
-webkit-font-feature-settings: "liga";
font-feature-settings: "liga";

 

  • Like 2

Share this post


Link to post
Share on other sites

wow that is awesome, the Safari mystery is solved!

  • Like 1

Share this post


Link to post
Share on other sites

Typographer will be getting an update soon. Functionally, everything should stay the same. PHP Typography is now available on Composer, and so I'd like to make use of it that way, considering its dependencies are also loaded in via Composer.

Haven't actually reviewed for any breaking changes in PHP Typography, but I don't think there would be many, if any at all...Once done, I think it'll be safe for me to bump to stable.

Share this post


Link to post
Share on other sites

Bumped to 0.3.0 - now using the Composer package, as above. There don't appear to be any breaking changes, other that the fact that the Settings class is now a separate entity. Also note that I'm keeping this in alpha for the simple reason that things may change. I don't expect to break anything, but would like to re-work the configuration class a little, add a few more features, and then bump to stable 1.0.0.

  • Like 2

Share this post


Link to post
Share on other sites

@Mike Rockett I like the use of release and the changelog - please keep it up. In fact, I think I need to adopt this with my own modules going forward. 

It would be really nice if ProcessUpgrades - or the PW core - could send us to a module's release notes before we decided to update it.

  • Like 1

Share this post


Link to post
Share on other sites
1 hour ago, netcarver said:

I like the use of release and the changelog - please keep it up. In fact, I think I need to adopt this with my own modules going forward. 

Thanks - I'm moving closer to a standardised approach. Deciding on whether to bump versions in a separate commit or not... Guess that really depends on what I'm doing, but most of the time the aim is to have one commit per release as there is no dev branch. (I might land up moving all my modules over to fetching from a release tag instead of master. I don't like the concept of multiple branches for dev/master, in the ProcessWire context. that is.)

1 hour ago, netcarver said:

It would be really nice if ProcessUpgrades - or the PW core - could send us to a module's release notes before we decided to update it.

Indeed - this has been brought up before, and I do like the idea. However, we'd need a standardised changelog format to include in our repositories. It could also be managed in a JSON fashion:

{
    "changelog": {
        "1.0.0": [
            "Log 1",
            "Log 2",
            "Log 3",
            "etc.",
        ],
        "0.9.9": [array]
    }
}

 

Share this post


Link to post
Share on other sites
48 minutes ago, Mike Rockett said:

However, we'd need a standardised changelog format to include in our repositories. It could also be managed in a JSON fashion:

It could be as simple as having an offsite link to the github release page for the version. I believe it could be auto-generated, as they all (currently) follow the same format...

https://github.com/<user>/<project>/releases/tag/<upgrade-version>
===================================
                 |
Known to PW from the module repository?

Updated to add: Yes, just trying the locally and it seems to work. Not difficult to pull the repo URL along with the other data and use it to add a "Changes" link next the new version. A little more use of WireHttp() requests to check if the links are sending back a 200 or 404 page and we'll know which items have release tags.

Share this post


Link to post
Share on other sites
37 minutes ago, netcarver said:

It could be as simple as having an offsite link to the github release page for the version. I believe it could be auto-generated, as they all (currently) follow the same format...

Sure, though module developers would need to be aware, in the same context as a standardised format, that proper release notes should go in there. It's a good idea.

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 Soma
      LogMaintenance
      A simple ProcessWire module to give some maintenance control over log files. I found myself often having lots of log files for different things that can grow more or less quickly to a size where they can be difficult to maintain. The built in Logger of PW does a good job of giving you the possibility to delete or prune logs. But it has to be done manually and sometimes a log grows into millions of lines, which makes it often impossible to even prune it as it's too large.
      LogMaintenance uses LazyCron to run the maintenance task and there's several settings you can setup on a global or per log basis.
      Archive: will create zip files for each log file in logs/archive/ folder and add the log each time the maintenance is run to a subfolder containing the datetime.
      Lines: keeps logs to a certain number of lines 
      Days: keeps the log to a certain number of days
      Bytes: keeps the log to a certain amount of bytes
      Each setting is checked from top down, the first setting to contain something is used. So if you check the "Archive" option, all other settings are ignored and logs are archived everytime the LazyCron is executed. If you want to keep your logs to a certain amount of bytes just leave all other settings to 0 or blank.
      Per Log Settings
      There's a textarea that you can use to setup a config for a specific log file one per line. All the logs you define here ignore the global settings above. The syntax for the settings is:
      logname:[archive]:[lines]:[days]:[bytes] 
      errors:1:0:0:0 // would archive the errors log messages:0:10000:0:0 // will prune the errors log to 10000 lines  
      The module can be found on github for you to check out. It's still fresh and I'm currently testing.
      https://github.com/somatonic/LogMaintenance
    • By teppo
      Fieldtype Page IDs is a third party Fieldtype that, simply put, stores Page references as integers (Page IDs).
      This fieldtype was built as a quick and dirty workaround for Page Reference fields' inability handle self-references due to circular reference issues. A project I've been working on for a while now includes a combination of RepeaterMatrix content blocks and tagging/categorization system that would've resulted in a lot of duplicate pages (and plenty of unnecessary manual work for content editors) had I used built-in Page Reference fields, and thus a new Fieldtype felt like the most sensible approach.
      Fieldtype Page IDs was designed to be loosely compatible with Page References in order to make conversions between the two feasible, but it is quite limited feature wise:
      largely due to the fact that stored values are actually just integers with no connection to Pages whatsoever some advanced selectors and related features are not supported, and page values can't be directly accessed configuration settings are limited to the bare essentials (selector string and Inputfield class) only a handful of Inputfields (AsmSelect, Checkboxes, Text) are (currently) supported Anyway, in case you need to store Page IDs (and Page IDs only) and are happy with the limitations mentioned above, feel free to give this Fieldtype a try. It has been working fine for me in one particular project, but hasn't been tested that much, so please tread carefully – and let me know if you run into any issues.
      GitHub repository: https://github.com/teppokoivula/FieldtypePageIDs
      Modules directory: https://modules.processwire.com/modules/fieldtype-page-ids/
    • By daniels
      This is a lightweight alternative to other newsletter & newsletter-subscription modules.
      You can find the Module in the Modules directory and on Github
      It can subscribe, update, unsubscribe & delete a user in a list in Mailchimp with MailChimp API 3.0. It does not provide any forms or validation, so you can feel free to use your own. To protect your users, it does not save any user data in logs or sends them to an admin.
      This module fits your needs if you...
      ...use Mailchimp as your newsletter / email-automation tool ...want to let users subscribe to your newsletter on your website ...want to use your own form, validation and messages (with or without the wire forms) ...don't want any personal user data saved in any way in your ProcessWire environment (cf. EU data regulation terms) ...like to subscribe, update, unsubscribe or delete users to/from different lists ...like the Mailchimp UI for creating / sending / reviewing email campaigns *I have only tested it with PHP 7.x so far, so use on owners risk
      EDIT:
      I've updated the module to 0.0.4. I removed the instructions from this forum, so I don't have to maintain it on multiple places. Just checkout the readme on github 🙂
      If you have questions or like to contribute, just post a reply or create an issue or pr on github. 
    • 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
      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 blynx
      Hej,
      A module which helps including Photoswipe and brings some modules for rendering gallery markup. Feedback highly appreciated
      (Also pull requests are appreciated 😉 - have a new Job now and don't work a lot with ProcessWire anymore, yet, feel free to contact me here or on GitHub, Im'm still "online"!)

      Modules directory: http://modules.processwire.com/modules/markup-processwire-photoswipe
      .zip download: https://github.com/blynx/MarkupProcesswirePhotoswipe/archive/master.zip
      You can add a photoswipe enabled thumbnail gallery / lightbox to your site like this. Just pass an image field to the renderGallery method:
      <?php $pwpswp = $modules->get('Pwpswp'); echo $pwpswp->renderGallery($page->nicePictures); Options are provided like so:
      <?php $galleryOptions = [ 'imageResizerOptions' => [ 'size' => '500x500' 'quality' => 70, 'upscaling' => false, 'cropping' => false ], 'loresResizerOptions' => [ 'size' => '500x500' 'quality' => 20, 'upscaling' => false, 'cropping' => false ], 'pswpOptions' => (object) [ 'shareEl' => false, 'indexIndicatorSep' => ' von ', 'closeOnScroll' => false ] ]; echo $pswp->renderGallery($page->images, $galleryOptions); More info about all that is in the readme: https://github.com/blynx/MarkupProcesswirePhotoswipe
      What do you think? Any ideas, bugs, critique, requests?
      cheers
      Steffen