Type 8 Plugin SDKtypefiwebcontent.s3.amazonaws.com/UserConference/2016/...HTML). +The overriding design goal for Markdown’s formatting syntax is to make it as readable as possible

Automation for print, online and mobile

© 2016 Typefi Systems Pty Ltd and its licensors. All rights reserved. Australia . USA . UK . Netherlands . typefi.com

Typefi 8 Plugin SDK Ben Hauser | VP Engineering

http://type%EF%AC%81.com


+ 14:00 – 15:00 Typefi 8 Plugin SDK

+ 15:00 – 15:30 Break

+ 15:30 – 17:00 Typefi 8 Server API

Schedule



+ Ben Hauser

+ Based in Queensland, Australia

+ Joined Typefi in 2003

+ Built Typefi Engine

+ VP Engineering since 2011

Presenter



+ The main idea in Typefi 8 was to rebuild Typefi Server from scratch.

+ Not just a rebuild but a total rethink of what the component could and should be.

+ This has been the central focus for the Typefi Engineering for the last few years.

Typefi 8



+ InDesign

– Adds support for InDesign CC (2015).

– Retain support for InDesign CC (2014), CC, CS6.

– Buy in Desktop, Workgroup or Cloud versions.

Typefi 8 Overview (1 of 5)



+ Client

– Brand new UI that is modern, responsive and mobile-friendly. It looks and feels great.

– New client side technology stack based on modern best-of-breed tools Bootstrap and jQuery.




+ Server

– We created the backend architecture to be super fast and reliable.

– We've updated the technology stack to modern, best-of-breed tools. Java 8. Tomcat 8.

– We invented a new architecture based on plugins that attach to a core server backbone.




+ Filestore

– Your Filestore is now a hierarchy. You can organise assets into folders as complex and as deep as you like. No more long, flat lists of projects.

– You can share templates much more easily and more naturally now. You can point to a shared template from anywhere in the Filestore.

– Filestore access built in to Writer and Designer.




+ Workflows

– A powerful way to quickly create your own, custom publishing workflows.

– We have modelled workflows as a series of discrete steps called Actions.

– We crafted an intuitive Workflow Editor that runs in any browser and enables you to create complex workflows very quickly by simply clicking and dragging.




+ Getting Started With Typefi 8 Demo

Demo



Typefi 8 Plugin SDK



+ The Typefi 8 Plugin SDK (Software Development Kit) enables you to build your own Typefi Actions that can be used seamlessly in Typefi Workflows.

Typefi 8 Plugin SDK



+ Download it from here: ahem…coming soon!

SDK Documentation



+ Use SDK if:

– You want to use Typefi's UI.

– You want to create a custom Typefi Action.

+ Use API if:

– You have an existing UI.

– You want to create your own UI.

SDK vs API



SDK Challenge



+ Create a Typefi Action that transforms Markdown documents into HTML.

SDK Challenge



http://daringfireball.net/projects/markdown/

+Markdown allows you to write using an easy-to-read, easy-to-write plain text format, then convert it to structurally valid XHTML (or HTML).

+The overriding design goal for Markdown’s formatting syntax is to make it as readable as possible. The idea is that a Markdown-formatted document should be publishable as-is, as plain text, without looking like it’s been marked up with tags or formatting instructions.

Markdown


http://daringfireball.net/projects/markdown/


+ To create a Typefi Action we must first create a Typefi Plugin.

+ Typefi Actions are packaged inside Typefi Plugins.

+ A Typefi Plugin is, at its heart, just an Java (Apache Tomcat) webapp that adheres to a few conventions.

Typefi Plugins


Apache Tomcat

ROOT

typefi-plugin-id

typefi-plugin-docx

typefi-plugin-xsl

typefi-plugin-md

Plugins Actions


+ We implemented Typefi Plugins as webapps for two reasons:

1. Hot deploy. Webapps can be installed and uninstalled on-the-fly without restarting the server.

2. Webapps are totally isolated from each other. Each has its own private Java class loader. So your Plugin can bundle any version of any jar file without impacting anything else on the server.

Typefi Plugins



+ Install Eclipse IDE for Java EE Developers from:

– https://eclipse.org/downloads/

+ Install Apache Tomcat 8 from:

– http://tomcat.apache.org/

Installation (step 1 of x)


https://eclipse.org/downloads/

http://tomcat.apache.org/


+ Open Eclipse and:

1. Click File / New / Project… / Web / Dynamic Web Project

2. Set Project name: typefi-plugin-md

3. Click Next > / Next >

4. Set Context root: typefi-plugin-md

5. Click Finish(note that the context root MUST start with the prefix “typefi-plugin-“. This enables Typefi Server to automatically detect your plugin when running in the same Tomcat instance)

Create Project (step 2 of x)



+ Typefi Plugins describe themselves via a descriptor

+ GET /descriptor

+ This endpoint must return a chunk of JSON that describes all the Actions (and their UIs) offered by your plugin. So I created the file:

+ WebContent/WEB-INF/conf/descriptor.json

Descriptor (step 3 of x)


descriptor.json

Descriptor.java


+ Show:

– http://localhost:8080/typefi-plugin-md/descriptor

– http://localhost:8080/actions


http://localhost:8080/typefi-plugin-md/descriptor

http://localhost:8080/actions


+ Let's now implement the Import Markdown Action.

+ The endpoint name is the “type” value as specified in the descriptor JSON above plus the string “/run”:

+ POST /md-to-html/run

Implement Action (step 4 of x)



env



action



+ https://github.com/rjeschke/txtmark

+ Yet another markdown processor for the JVM.

+ It is easy to use.

+ It is flippin' fast.

+ It does not depend on other libraries.

Txtmark


https://github.com/rjeschke/txtmark


+ It is good behaviour for an action to write what’s going on to a log file.

+ The recommended format is:

– YYYY-MM-DDTHH:MM:SS.SSSZ XXXX MESSAGE

+ where:

– YYYY-MM-DDTHH:MM:SS.SSSZ is the ISO 8601 date in UTC.

– XXXX is the message category, one of:

• DBUG a debug message.

• INFO an informational message.

• WARN a warning message.

• ERRO an error message.

• FILE / PROG / STAT (used by the Typefi Engine).

Logging



+ Valid values for ActionResult.StatusCode:

– DONE

– CANCELLED

– DELETED

– FAILED

– INITIALIZED

– INPROGRESS

– PENDING

Error Handling



+ Currently, an action MUST be licensed to run.

+ This is somewhat restrictive for 3rd parties.

+ We aim to make this more straightforward in a future release.

+ For the time being contact Typefi and we can issue licenses for your custom actions on a case-by-case basis.

Licensing



+ POST /md-to-html/status

+ POST /md-to-html/cancel

Long Running Actions



Ben Hauser | VP Engineering [email protected]


mailto:[email protected]

Documents

Type 8 Plugin SDKtypefiwebcontent.s3.amazonaws.com/UserConference/2016/...HTML). +The overriding design goal for Markdown’s formatting syntax is to make it as readable as possible