Table of Contents
This workflow will utilize the following tools, on mobile and desktop platforms.
Resources
Overview
UXWrite is an application for iOS mobile platforms - both the iPhone and the iPad mobile platforms. The application can be used to write documentation in HTML and DOCX formats, and can synchronize documents from mobile to the cloud, via Dropbox. When authoring HTML documents, UXWrite makes thorough use of Cascading Stylesheet (CSS) classes, for configuring the formatting and display of text, tables, and lists in the document.
UXWrite 1.1.4 supports at least two methods for making a document available over a network:
Send via Email: Email the document as an attachment, in original format (HTML or DOCX) or in PDF Cloud Synch via Dropbox: Creat the document, "On the cloud," whether immediately on Dropbox or in a locally cached folder, such that would be synchronized with Dropbox when the app is connected via the device to a data network.
This workflow document will address the second methodology, Cloud Synch via Dropbox.
Resources
Overview
When HTML documents are made in accordance with published technical standards for HTML formatting, those documents can be processed within documentary workflows, using viewer applications and document processing tools, with minimal adjustments for the input documents.
In HTML5, an HTML document may be formatted as XML or as an effective subset of broader SGML. HTML5 documents formatted, thusly, as SGML may typically be converted to XML format - specifically, XHTML - though possibly in using some ad-hoc methodologies.
Once converted to XHTML, an HTML5 document may be rocessed with an XSL Transform engine, such as Apache Xalan or Saxon, in a process using an XSL stylesheet to transform selected XML input expressions into output expressions of a format selected by the author of the XSL stylesheet. Using XSL extension functions, additional processing may be performed on the input document, furthermore, without necessarily generating an output document in the process.
IN that sense, an HTML document created with an HTML authoring tool such as UX Write may be processed for inclusion of additional HTML markup, such as additional metadata, or alternately, for injection within broader documentation templates, for producing standard formatted documentation, within a project.
The remainder of this document should serve to describe a process for template injection of HTML documents authored using UX Write
Resources
Overview
SSH is a protocol providing features of authentication and non-repudiation, in networked communication with remote command shells and remote filesystems. SSH shell and filesystem features are provided to projects hosted at SourceForge.net. Documentation is available, specifically, about using SCP for remote file transfers for projects hosted by SourceForge.net.
JSch provides a Java library for accessing the SSH protocol within Java applciations. JSch is supported with Apache Ant, specifically in the the Ant scp task.
Resources
Resources