-
Notifications
You must be signed in to change notification settings - Fork 32
Installation
Updated for v1.1.
At least two methods are available. Which is better for you depends on you.
This is a good way to go if you wish oXygen to be able to receive updates to the JATS framework, or to provide for restoring the framework after an oXygen upgrade.
In oXygen Help > Install New Add-ons, into "Show Add-ons from:" paste the URL
https://github.com/wendellpiez/JATSKit/raw/master/oXygenJATSframework.xml
Alternatively, if you want the current development version (which could be ahead of master):
https://github.com/wendellpiez/JATSKit/raw/develop/oXygenJATSframework.xml
Upon your entering this, JATSKit should appear as an add-on. JATSKit was (most recently) tested with oXygen 17.1 but it should "degrade gracefully" to older versions of oXygen, so don't hesitate to try it. (Just be aware some features may be missing or may fail. It will not harm your oXygen or your data.)
Having checked the box for JATSKit, you will proceed through a short series of screens asking you to accept the license agreement.
You will also experience a hiccup when it is announced that "Not all selected Add-ons have valid signatures" etc. etc. Ignore this warning. Continue Anyway.
As the lead developer understands it (IANAL) the Apache 2.0 license essentially prohibits you from claiming IP over JATSKit or its parts but leaves you free to reuse and modify it as well as to share your modifications; of course contributors to JATSKit, or to its core components, in the past have included the US National Library of Medicine (NCBI); Mulberry Technologies, Inc.; Syncro Soft (developers of oXygen); and others including members of the community. It is to be hoped and encouraged that future developers will be inspired to do the same, and share alike.
If you wish to help improve future versions of JATSKit see the Contributing page.
If you don't like things to to be this automated, download and unzip the distribution and copy it into the frameworks folder of your oXygen installation. (Rename it to JATSKit if it has come with another name.) Or copy it to the folder of your choice and add this folder (the parent folder of the unpacked directory) to your Additional frameworks directories in oXygen (see Options > Preferences > Document Type Association > Locations).
These options make it easier to develop local customizations that "layer" and improve on JATSKit, without having to modify the distribution itself.
Please fork! JATSKit comes with no warranty and its JATS usage semantics have been prescribed, mandated or indeed condoned by no one. It has no authority of its own. It is most useful to those willing to provide local authority and to maintain and modify it on that basis.
One way of doing this is to fork the entire installation into a local copy using git, and then installing using the same method as described above, except pointing to your own files and configuration.
oXygen makes it easy to extend or branch frameworks (as just described), so you should not have to break JATSKit open and steal its internals for reuse elsewhere. But you are free to do so. JATSKit is distributed with the intention that it be modified, supplemented and improved for local use.
Once the framework is available in oXygen, oXygen will recognize as JATS any document whose DOCTYPE declaration (in the document prolog) includes an FPI (Formal Public Identifier) identified with the framework. (See the page DTD versions for more specific info.) While the list of associated document types is limited in the general distribution, it can easily be supplemented with bindings for your own DTD by extending the framework, as described on that page.
When a document is recognized as associated with the main JATSKit framework or one of its extensions, oXygen will make the framework's various features available (including display stylesheets, transformation scenarios, and inline documentation among others). Other features, such as refactoring stylesheets, may be available to any document in oXygen when the framework is installed. (See the one that assigns the Blue FPI to any document in your system, for example.) In addition, you will be able to tell the framework is working since JATS or JATSKit menu items will appear in various places.