Jump to content

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.

  • Like 17

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 MoritzLost
      This module allows you to integrate hCaptcha bot / spam protection into ProcessWire forms. hCaptcha is a great alternative to Google ReCaptcha, especially if you are in the EU and need to comply with privacy regulations.

      The development of this module is sponsored by schwarzdesign.
      The module is built as an Inputfield, allowing you to integrate it into any ProcessWire form you want. It's primarily intended for frontend forms and can be added to Form Builder forms for automatic spam protection. There's a step-by-step guide for adding the hCaptcha widget to Form Builder forms in the README, as well as instructions for API usage.
      Features
      Inputfield that displays an hCaptcha widget in ProcessWire forms. The inputfield verifies the hCaptcha response upon submission, and adds a field error if it is invalid. All hCaptcha configuration options for the widget (theme, display size etc) can be changed through the inputfield configuration, as well as programmatically. hCaptcha script options can be changed through a hook. Error messages can be translated through ProcessWire's site translations. hCaptcha secret keys and site-keys can be set for each individual inputfield or globally in your config.php. Error codes and failures are logged to help you find configuration errors. Please check the README for setup instructions.
      Links
      Github Repository and documentation InputfieldHCaptcha in the module directory (pending approval) Screenshots (configuration)

      Screenshots (hCaptcha widget)

       
       

       
    • 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="text/plain" data-type="text/javascript" data-category="statistics" data-src="/path/to/your/statistic/script.js"></script> <script type="text/plain" data-type="text/javascript" data-category="marketing" data-src="/path/to/your/mareketing/script.js"></script> <script type="text/plain" data-type="text/javascript" data-category="external_media" data-src="/path/to/your/external-media/script.js"></script> <script type="text/plain" 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: PrivacyWire Git Repo
      Download as .zip
      I would love to hear your feedback 🙂
      CHANGELOG
      0.1.1 Debugging: fixed error during uninstall 0.1.0 Added new detection of async scripts for W3C Validation 0.0.6 CSS-Debugging for hiding unused buttons, added ProCache support for the JavaScript tag 0.0.5 Multi-language support included completely (also in TextFormatter). Added possibility to async load other assets (e.g. <img type="optin" data-category="marketing" data-src="https://via.placeholder.com/300x300">) 0.0.4 Added possibility to add an imprint link to the banner 0.0.3 Multi-language support for module config (still in development) 0.0.2 First release 0.0.1 Early development
    • By bernhard
      --- Please use RockFinder3 ---
    • 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 (pending approval) If you are interested in learning more, the README is very extensive, with more usage examples, code samples and usage instructions!
    • By Craig
      I've been using Fathom Analytics for a while now and on a growing number of sites, so thought it was about time there was a PW module for it.
      WayFathomAnalytics
      WayFathomAnalytics is a group of modules which will allow you to view your Fathom Analytics dashboard in the PW admin panel and (optionally) automatically add and configure the tracking code on front-end pages.
      Links
      GitHub Readme & documentation Download Zip Modules directory Module settings screenshot What is Fathom Analytics?
      Fathom Analytics is a simple, privacy-focused website analytics tool for bloggers and businesses.

      Stop scrolling through pages of reports and collecting gobs of personal data about your visitors, both of which you probably don't need. Fathom is a simple and private website analytics platform that lets you focus on what's important: your business.
      Privacy focused Fast-loading dashboards, all data is on a single screen Easy to get what you need, no training required Unlimited email reports Private or public dashboard sharing Cookie notices not required (it doesn't use cookies or collect personal data) Displays: top content, top referrers, top goals and more
×
×
  • Create New...