Jump to content

Typographer


Mike Rockett
 Share

Recommended Posts

TextformatterTypographer

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.

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.

  • Like 17
Link to comment
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
Link to comment
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
Link to comment
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
Link to comment
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
Link to comment
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).

Link to comment
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
Link to comment
Share on other sites

  • 3 weeks later...

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...

Link to comment
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.

Link to comment
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?

Link to comment
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)...

Link to comment
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.

Link to comment
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
Link to comment
Share on other sites

  • 8 months later...

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.

Link to comment
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
Link to comment
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
Link to comment
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]
    }
}

 

Link to comment
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.

Link to comment
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.

Link to comment
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
 Share

  • Recently Browsing   0 members

    • No registered users viewing this page.
  • Similar Content

    • By MarkE
      This fieldtype and inputfield bundle was built for storing measurement values within a field, rendering them in a variety of formats and converting them to other units or otherwise modifying them via the API.
      The API consists of a number of predefined functions, some of which include...
      render() for rendering the measurement object, valueAs() for converting the value to another unit value, convertTo() for converting the whole measurement object to different units, and add() and subtract() for for modifying the stored value by the value (converted as required) in another measurement. In the admin the inputfield includes a checkbox (which can be optionally disabled) for converting values on page save. For an example if a value was typed in as centimeters, the unit was changed to metres, and the page saved with this checkbox selected, said value would be automatically converted so that e.g. 170 cm becomes 1.7 m.

      A simple length field using Fieldtype Measurement and Inputfield Measurement.
      Combination units (e.g. feet and inches) are also supported.
      Please note that this module is 'proof of concept' at the moment - there are limited units available and quite a lot of code tidying to do. More units will be added shortly.
      See the GitHub at https://github.com/MetaTunes/FieldtypeMeasurement for full details and updates.
    • By tcnet
      File Manager for ProcessWire is a module to manager files and folders from the CMS backend. It supports creating, deleting, renaming, packing, unpacking, uploading, downloading and editing of files and folders. The integrated code editor ACE supports highlighting of all common programming languages.
      https://github.com/techcnet/ProcessFileManager

      Warning
      This module is probably the most powerful module. You might destroy your processwire installation if you don't exactly know what you doing. Be careful and use it at your own risk!
      ACE code editor
      This module uses ACE code editor available from: https://github.com/ajaxorg/ace

      Dragscroll
      This module uses the JavaScript dragscroll available from: http://github.com/asvd/dragscroll. Dragscroll adds the ability to drag the table horizontally with the mouse pointer.
      PHP File Manager
      This module uses a modified version of PHP File Manager available from: https://github.com/alexantr/filemanager
       
    • By tcnet
      This module implements the website live chat service from tawk.to. Actually the module doesn't have to do much. It just need to inserted a few lines of JavaScript just before the closing body tag </body> on each side. However, the module offers additional options to display the widget only on certain pages.
      Create an account
      Visit https://www.tawk.to and create an account. It's free! At some point you will reach a page where you can copy the required JavaScript-code.

      Open the module settings and paste the JavaScript-code into the field as shown below. Click "Submit" and that's all.

      Open the module settings
      The settings for this module are located int the menu Modules=>Configure=>LiveChatTawkTo.

       
    • By tcnet
      Session Viewer is a module for ProcessWire to list session files and display session data. This module is helpful to display the session data of a specific session or to kick out a logged in user by simply delete his session file. After installation the module is available in the Setup menu.

      The following conditions must be met for the module to work properly:
      Session files
      Session data must be stored in session files, which is the default way in ProcessWire. Sessions stored in the database are not supported by this module. The path to the directory where the session files are stored must be declared in the ProcessWire configuration which is by default: site/assets/sessions.
      Serialize handler
      In order to transform session data easier back to a PHP array, the session data is stored serialized. PHP offers a way to declare a custom serialize handler. This module supports only the default serialize handlers: php, php_binary and php_serialize. WDDX was dropped in PHP 7.4.0 and is therefore not supported by this module as well as any other custom serialize handler. Which serialize handler is actually used you can find out in the module configuration which is available under Modules=>Configure=>SessionViewer.

      Session data
      The session data can be displayed in two different ways. PHP's default output for arrays print_r() or by default for this module nice_r() offered on github: https://github.com/uuf6429/nice_r. There is a setting in the module configuration if someone prefers print_r(). Apart from the better handling and overview of the folded session data the output of nice_r() looks indeed nicer.

      Links
      ProcessWire module directory
      github.com
    • By Robin S
      Repeater Easy Sort
      Adds a compact "easy-sort" mode to Repeater and Repeater Matrix, making those fields easier to sort when there are a large number of items.
      The module also enhances Repeater Matrix by allowing a colour to be set for each matrix type. This colour is used in the item headers and in the "add new" links, to help visually distinguish different matrix types in the inputfield.
      Screencasts
      A Repeater field

      A Repeater Matrix field with custom header colours

      Easy-sort mode
      Each Repeater/Matrix item gets an double-arrow icon in the item header. Click this icon to enter easy-sort mode.
      While in easy-sort mode:
      The items will reduce in width so that more items can be shown on the screen at once. The minimum width is configurable in the field settings. Any items that were in an open state are collapsed, but when you exit easy-sort mode the previously open items will be reopened. You can drag an item left/right/up/down to sort it within the items. The item that you clicked the icon for is shown with a black background. This makes it easier to find the item you want to move in easy-sort mode. You can click an item header to open the item. An "Exit easy-sort mode" button appears at the bottom of the inputfield. Configuration
      In the field settings for Repeater and Repeater Matrix fields you can define a minimum width in pixels for items in easy-sort mode. While in easy-sort mode the items will be sized to neatly fill the available width on any screen size but will never be narrower than the width you set here.
      In the field settings for Repeater Matrix you can define a custom header colour for each matrix type using an HTML "color" type input. The default colour for this type of input is black, so when black is selected in the input it means that no custom colour will be applied to the header.
      Exclusions
      The easy-sort mode is only possible on Repeater/Matrix fields that do not use the "item depth" option.
       
      https://github.com/Toutouwai/RepeaterEasySort
      https://processwire.com/modules/repeater-easy-sort/
×
×
  • Create New...