Can <oXygen/> XML Web Author work with my documents? Hello everybody! My name is Cristian. If you looked around lately in the technical documentation community, you might have noticed the web authoring trend. Its benefit is that it lowers the entry barrier for content development to the point where anyone can write structured content. However, web authoring is not just about the authoring tool, oXygen XML Web Author, it’s also about the document being edited. That’s why I will try to answer the question in the session title: “Can Web Author work with my documents?” Cristian Talau cristi_talau@oxygenxml.com @ctalau

Can Web Author work in my content ecosystem? After you think more about it, is not only about documents, it about the entire ecosystem in which the documents leave. Can Web Author work in my “Content Ecosystem”?

Can Web Author work in my content ecosystem? Services - file storage (CMS, Git, SVN, Sharepoint, etc.), user management Workflows - review, external contributions Formats - schema, reuse, profiling Conventions - styleguide, tone of voice Such an ecosystem is composed of “Services”, “Workflows”, “Formats” and “Conventions”. To leverage all the benefits of web authoring, you need a solution in which the authoring tool is seamlessly integrated with all these components.

File storage integration - no direct access for external users - oXygen XML Collaboration Platform Workflows tailored for external users CMS agnostic – oXygen XML Editor is the bridge Traditionally, CMS-es or content ecosystems were only used by technical authors. Most of them do not have user-roles and specific workflows for external contributions / reviewers. It works basically as an add-on that provides workflows for external users. It does not connect directly to the CMS, which means there is no need for a connector or to worry about compatibility.

File storage integration - WebDAV integration - Builtin WebDAV support File browsing Automatic locking Auto-save DEMO The simplest way to integrate Web Author is by using the builtin WebDAV support. I will show you how to connect it to box.com in 2 minutes. If you do not have a WebDAV interface, we designed an alternative simpler REST API. It's just 5 simple endpoints to implement and you get all the above features plus Single-Sign-On. You can also customize the CMS browser for a better integration.

File storage & workflows integration - Git - Generic Git support for BitBucket, GitLab, etc. Browse, open and commit documents Automatic merge in case of conflicts Enhanced support for GitHub: Single-Sign-On Repository chooser Pull-request workflows https://github.com/georgebina/ghd-wiki https://bitbucket.org/cristi_talau/flowers cristi_talau@sync.ro oxygen17

File storage & workflows integration - SVN - VisualSVN is pretty simple to setup for windows users.

File storage & workflows integration - SVN - VisualSVN is pretty simple to setup for windows users.

File storage & workflows integration - SVN - Besides the WebDAV features, you get Versioning External changes merging workflow DEMO [DEMO] - create a branch - open in web author - send the link - SME modifies something as well - Merge the changes w/ the diff dialog

File storage & workflows integration - Sharepoint - Web Author can be used out-of-the-box: Single-sign-on Check-in/Check-out workflow … more features available with DitaExchange as a CMS Once your content grows out of the Sharepoint's scope, you can use DitaExchange as a Sharepoint-based CMS.

File storage integration - REST API integration - Besides the WebDAV functionality: Single Sign On Easily customizable file browser Endpoints Open & save files /files: GET, PUT Builtin folder-oriented file browser /folders: GET; /files: POST, DELETE Custom file browser widget /browse: GET The simplest way to integrate Web Author is by using the builtin WebDAV support. I will show you how to connect it to box.com in 2 minutes. If you do not have a WebDAV interface, we designed an alternative simpler REST API. It's just 5 simple endpoints to implement and you get all the above features plus Single-Sign-On. You can also customize the CMS browser for a better integration.

File storage integration Conclusion Git - checked The simplest way to integrate Web Author is by using the builtin WebDAV support. I will show you how to connect it to box.com in 2 minutes. If you do not have a WebDAV interface, we designed an alternative simpler REST API. It's just 5 simple endpoints to implement and you get all the above features plus Single-Sign-On. You can also customize the CMS browser for a better integration.

File storage integration Conclusion Supported CMS? DONE WebDAV support? DONE Extendable CMS? DONE GitHub or another Git server? DONE SVN server? DONE Sharepoint? DONE UserManual.pdf

Workflow integration – edit links Place “Edit” links On JIRA issues In the CMS context menus In the published document UserManual.pdf

Workflow integration – edit links Endpoint Dashboard URL http://domain.com/webauthor/app/oxygen. html Query params url – file URL ditamap – dita map URL author – the display name of the author UserManual.pdf

Workflow integration – edit links GitHub https://github.com/ctalau/flowers/blob/master/flowers.ditamap github://getFileContent/ctalau/flowers/master/flowers.ditamap WebDAV https://dav.box.com/dav/flowers/flowers.ditamap webdav-https://dav.box.com/dav/flowers/flowers.ditamap Shrepoint https://syncro.sharepoint.com/SharedDocs/topic.dita spo-https://syncro.sharepoint.com/SharedDocs/topic.dita UserManual.pdf

Document Formats Oxygen Author frameworks can be reused Web Author test server add-on Customize frameworks in oXygen Author Desktop Open sample documents in Web Author DEMO: importing a DITA specialization DEMO: CSS paged layout for a document type Dita specialization :root{ border: 1px solid #c6c6c6; background-color:white; margin: 0.25in auto; width: 21.59cm; min-height:10cm; }

Styleguide support Trade-off between conventions learning curve and content quality Let them discover it on the fly when they break some rule And also teach them how to fix the issue Linguistic conventions Acrolinx integration DEMO: kubernetes styleguide Content contribution is a voluntary task, the effort of even reading the styleguide may be prohibitive Kubernetes

Continuing the integration Create an MVP Demo to clients & gather requirements Initial technical discussion with oXygen Design the architecture of the system Estimate the complexity of the requirements Obtain pointers to docs & development licenses E-mail technical support Back to #2 From our experience, an integration project proceeds as follows. 1. First of all you need an MVP using our WebDAV / REST APIs. Companies are slow to adopt new technology, so you should start negotiations early. 2. With an MVP can start advertising the integration and start collecting feedback. 3. Once you have a prioritized list of requirements, we should start with an initial technical discussion. During this discussion we can: - Design the architecture of the system – chances are we had similar requirements from other integrations and that we can point you in the right direction. - Estimate the complexity. Some of the requirements are a matter of configuration, some need code to be written, some of them require oXygen to add new API, some of them are just impossible, 4. After that, you may still have questions. We are happy to answer your emails. 5. After the integration is finished we need to iterate again, maybe for another client, maybe to improve the experience of the current client.

Thank you! Questions? Thank you <oXygen/> XML Editor http://www.oxygenxml.com cristi_talau@oxygenxml.com