Post on 21-Jun-2020
transcript
George Binageorge@oxygenxml.com
@georgebina #xmlprague
Making XML Editable on the Web
@georgebina Copyright @ Syncro Soft, 2017. All rights reserved.
Making XML editable on the Web
XAAS – XML Authoring as Service
oXygen XML Web Author =
A REST service to interact with XML content!
Parameters
• url – pointing to the file to edit
• ditamap – pointing to a DITA map for editing
context
• … – more parameters are available
@georgebina Copyright @ Syncro Soft, 2017. All rights reserved.
Making XML editable on the Web
Integration is key
web XML editor ≠ opening XML to edit in browser
The real power of a web editor can be seen
when it is integrated to optimize or to enable a
workflow!
@georgebina Copyright @ Syncro Soft, 2017. All rights reserved.
Making XML editable on the Web
Desktop editor
GitHub contribution workflow
original
remote
repository
dita-ot/docs
your
remote
repository
1. fork
your local
repository
branch
2. clone
Working
copy
3. checkout
4. change
5. commit
6. push
7. pull
request
Edited
File
GitHub
Local
@georgebina Copyright @ Syncro Soft, 2017. All rights reserved.
Making XML editable on the Web
Desktop editor
GitHub contribution workflow
your
remote
repository
1. fork
your local
repository
branch
2. clone
Working
copy
3. checkout
4. change
5. commit
6. push
7. pull
request
Edited
File
GitHub
Local
original
remote
repository
dita-ot/docs
@georgebina Copyright @ Syncro Soft, 2017. All rights reserved.
Making XML editable on the Web
Hide GitHub complexity
From
• Fork remote
• Clone locally
• Branch
• Checkout working copy
• Change• Commit locally• Push to remote
• Send pull request
To
• Change
• Save/Commit
Automate parts of the contribution workflow
@georgebina Copyright @ Syncro Soft, 2017. All rights reserved.
Making XML editable on the Web
Simplified workflow
original
remote
repository
Edited
File
1. change
2. save à fork + commit/push + pull request
@georgebina Copyright @ Syncro Soft, 2017. All rights reserved.
Making XML editable on the Web
Technical support to documentation
A support incident is an opportunity to improve
your product documentation!
@georgebina Copyright @ Syncro Soft, 2017. All rights reserved.
Making XML editable on the Web
Review product documentation
Involve developers to review product
documentation!
@georgebina Copyright @ Syncro Soft, 2017. All rights reserved.
Making XML editable on the Web
Review documentation
Jira
Issue
• description
• comment
• code changes
• documentation
changes
Source repository
GitHub
• Documentation
repository
@georgebina Copyright @ Syncro Soft, 2017. All rights reserved.
Making XML editable on the Web
Review documentation
Jira
Issue
• description
• comment
• code changes
• documentation
changes
Source repository
GitHub
• Documentation
repository
review/edit
modified
documentation
@georgebina Copyright @ Syncro Soft, 2017. All rights reserved.
Making XML editable on the Web
Review documentation
Jira
Issue
• description
• comment
• code changes
• documentation
changes
• review/edit modified
documentation
Source repository
GitHub
• Documentation
repository
oXygen XML
Web Author
@georgebina Copyright @ Syncro Soft, 2017. All rights reserved.
Making XML editable on the Web
Email notifications with links
@georgebina Copyright @ Syncro Soft, 2017. All rights reserved.
Making XML editable on the Web
Link to changes topics
click to
review/edit
@georgebina Copyright @ Syncro Soft, 2017. All rights reserved.
Making XML editable on the Web
Immediate edit access
@georgebina Copyright @ Syncro Soft, 2017. All rights reserved.
Making XML editable on the Web
Click to see changes
@georgebina Copyright @ Syncro Soft, 2017. All rights reserved.
Making XML editable on the Web
DITA-OT documentation
Services used by the DITA-OT documentation
• GitHub• storage
• versioning
• access control
• GitHub Pages• web publishing
• Travis• automate publishing
• Slack• project communication
@georgebina Copyright @ Syncro Soft, 2017. All rights reserved.
Making XML editable on the Web
And they are connected
GitHubRepositories
• dita-ot.github.io
• docs
GitHub Pages
• www.dita-ot.org
Travis
publish
scripts
Slack
@georgebina Copyright @ Syncro Soft, 2017. All rights reserved.
Making XML editable on the Web
New service – XML authoring
• GitHub• storage
• versioning
• access control
• oXygen XML Web Author• XML Authoring
• GitHub Pages• web publishing
• Travis• automate publishing
• Slack• project communication
@georgebina Copyright @ Syncro Soft, 2017. All rights reserved.
Making XML editable on the Web
And we integrate it in the workflow
GitHubRepositories
• dita-ot.github.io
• docs
GitHub Pages
• www.dita-ot.org
Travis
publish
scripts
Slack
oXygen XML Web Author
online editor
@georgebina Copyright @ Syncro Soft, 2017. All rights reserved.
Making XML editable on the Web
Click on website to edit its content
@georgebina Copyright @ Syncro Soft, 2017. All rights reserved.
Making XML editable on the Web
DITA-OT documentation website
edit link
http://www.dita-ot.org/dev/
@georgebina Copyright @ Syncro Soft, 2017. All rights reserved.
Making XML editable on the Web
Edit the source content
@georgebina Copyright @ Syncro Soft, 2017. All rights reserved.
Making XML editable on the Web
Save to send a request for change
@georgebina Copyright @ Syncro Soft, 2017. All rights reserved.
Making XML editable on the Web
xproc.org and exproc.org
Similar services (GitHub, Travis, GitHub Pages)
but this time the source is DocBook.
Integrates the web authoring via the “Edit this
page on GitHub” links
http://www.xproc.org
http://www.exproc.org
@georgebina Copyright @ Syncro Soft, 2017. All rights reserved.
Making XML editable on the Web
DITA+Markdown based Wiki
Website
(GitHub Pages)
link to edit page
GitHub
• Documentation
repository
oXygen XML
Web Author
Travis
@georgebina Copyright @ Syncro Soft, 2017. All rights reserved.
Making XML editable on the Web
Website content
https://georgebina.github.io/ghd-wiki/
@georgebina Copyright @ Syncro Soft, 2017. All rights reserved.
Making XML editable on the Web
Lightweight DITA topic
History and Edit links
@georgebina Copyright @ Syncro Soft, 2017. All rights reserved.
Making XML editable on the Web
Revisions history
@georgebina Copyright @ Syncro Soft, 2017. All rights reserved.
Making XML editable on the Web
Controlled AX online editor
@georgebina Copyright @ Syncro Soft, 2017. All rights reserved.
Making XML editable on the Web
Markdown topic
@georgebina Copyright @ Syncro Soft, 2017. All rights reserved.
Making XML editable on the Web
GitHub Markdown editor
@georgebina Copyright @ Syncro Soft, 2017. All rights reserved.
Making XML editable on the Web
Travis project status
https://travis-ci.org/georgebina/ghd-wiki/builds
@georgebina Copyright @ Syncro Soft, 2017. All rights reserved.
Making XML editable on the Web
TEI Journal
TEI CSS customization for TEI Journal articles:
https://github.com/georgebina/jteiPlus
Sample:
https://www.oxygenxml.com/webapp-demo-
aws/app/oxygen.html?url=github%3A%2F%2FgetFileC
ontent%2Fgeorgebina%2FjteiPlus%2Fmaster%2Fsam
ples%2FJTEI%2Fjtei_8_eide_source%2FDEMOjtei-8-
eide-source.xml
@georgebina Copyright @ Syncro Soft, 2017. All rights reserved.
Making XML editable on the Web
Take-aways
Integration is key for web XML authoring!
Contributing to XML-based systems cannot be
easier:
Click – Edit – Save – Describe what you changed
We can turn any system into a wiki like system
where anyone can edit the content
Contributions can be reviewed before they are
published (content curation)
@georgebina Copyright @ Syncro Soft, 2017. All rights reserved.
Making XML editable on the Web
Thank you
Questions?
george@oxygenxml.com
@georgebina
http://www.oxygenxml.com