search

Maksakovsky-admin / technical

0 stars 0 forks source link

oXygen #17

Open dentarthur opened 5 years ago

dentarthur commented 5 years ago

Links here. Start with DITA links. Also download manuals.

https://github.com/BaseXdb/basex/issues/1656#issuecomment-454618468

dentarthur commented 5 years ago

To clarify:

Ignore first part. You are the "non-technical" author who might prefer standalone oXygen without Eclipse IDE. I sort out connection to database backend - not your problem.

Only these links relevant for you:

====

I am looking for simple use of Editor for DITA by non-technical author without added confusion from an IDE. BaseX backend should be a good fit.

https://www.oxygenxml.com/xml_editor/dita_editor.html

https://www.oxygenxml.com/xml_editor/dita_editor_structured_editing.html

https://www.oxygenxml.com/xml_editor/dita_maps_manager.html

etc etc follow links

Also

https://www.oxygenxml.com/doc/versions/20.0/ug-editorEclipse/topics/migrate-archives.html

Similar use cases for other WYSIWYG eg docbook and epub authors:

https://www.oxygenxml.com/xml_editor/WYSIWYG_Editors.html

https://www.oxygenxml.com/xml_editor/docbook_editor.html

DavidMc1948 commented 5 years ago

Free Open Source. How does it compare?

DITA Open Toolkit

dentarthur commented 5 years ago

FYI:

I just got a non-commital response to my email 3 days ago, 2019-01-21T2037 to main LwDITA author, Carlos Evia, requesting copy of a paper and outlining my current assumptions:

"Hi Arthur,

Thank you for your interest in Lightweight DITA. Ingenta Connect sells individual access to the article via this page: https://www.ingentaconnect.com/content/stc/tc/2016/00000063/00000001/art00004 However, we wrote that paper in 2016 and things have changed with Lightweight DITA. If you want a more accurate and recent version of the proposed standard, you can download (for free; it is open) our recent introductory committee note from http://docs.oasis-open.org/dita/LwDITA/v1.0/cn02/LwDITA-v1.0-cn02.html That sounds like an interesting exploration. As you know, LwDITA is still experimental, and early adoption cases like yours are very important for its future.

Best,

Carlos "

Here are my assumptions:

"

  1. Can you offer any quick comment on the following? (eg "Forget it! Just do something simpler for now.")

I am worried that I may be on wrong track. Considering DITA-OT plus dita4publishers additions with oXygen XMLeditor plug-in for Eclipse using Github as repository and also connected for XQuery 3 via XQDT connector as well as webdav to BaseX XML database. But have NO experience with ANY of these technologies. Does that combination make sense or is there some better way given (lack of) budget and expertise described below?

  1. I am evaluating use of LwDITA for authoring draft papers for submission, mainly in economics journals, and publishing drafts as working papers, for a VERY tiny research group with no funds, support staff or competent developers.

Expect to eventually be producing Agent Based models and exploratory explanations with interactive animations and simulations and to become capable of using JupyterLab and Eclipse/Papyrus/Moka for executable UML animations to publish on static web pages. But currently zero actual experience with any development tools. Should we just stick to something like pandoc scholar for short term needs until actually acquired some familiarity with other tools?

  1. My current thought is that collaborative authoring on Github with plain GFM markdown plus subsequent addition of extended MDITA by internal reviewer/editor more familiar with DITA would not be disruptive and could later be useful for combining topics into multiple variations of papers addressed to different audiences and eventually for adding simple interactive visualizations with idyll-lang.org and ObservableHQ.com

  2. I am assuming that it will soon be normal to include interactive animations with journal papers, starting in biology but also extending to economics. So there will be DITA plug-ins to include them in EPUB3.2 or later. So the extra work familiarizing with Eclipse, oXygen and DITA will not end up being wasted even though it may be overkill at the moment.

  3. I have looked around for links on use of DITA and LwDITA in publishing simple articles for academic journals, but only found references to use by academics for teaching technical communications (and by code developers familiar with Markdown for software documentation). If you can point me to anything relevant, please do.

  4. Anyway, thanks VERY much for LwDITA! Whether or not we can start out with it I am sure we will end up using it eventually."

dentarthur commented 5 years ago

See also #14

I think it is safe enough to assume we will definately be ordering oXygen (Linux eclipse-plugin academic version) for USD $99.

This requires installing latest JDK as explained above. But adding BaseX XML database can come later.

I just wrote these notes on JATS:

https://github.com/thecapitalistcycle/tech-indexing/blob/master/jatskit.md

Starting with JATS (included in oXygen) will be necessary before doing anything with LwDITA (and adding pandoc-jats) will be a necessary intermediate step.

As soon as you have a working Linux with JDK and Eclipse installed, please go ahead with 30 day free trial oXygen and aim to setup association entitled to academic discount soon after.

Meanwhile you could also do 30 day free trial on Windows as soon as you are bored with XMLmind.

With that off my chest I can now focus on reading "Forgotten" ;-)

DavidMc1948 commented 5 years ago

JDK installed.

I read that I needed to install python before installing Eclipse. So I did that.

I have downloaded Eclipse but having problems installing. I click on the Ooomph EclipseInstaller and get an "internal error" . I am asked if I want to do an update. I have done that a number of times but it does not help.

dentarthur commented 5 years ago

Will chat tomorrow or later.

Expect LOTS of similar mysteries.

Meanwhile just familiarize with Fedora generally. You may find it is JUST unfamiliarity.

There are tutorials and how tos for Linux newbies.

Set yourself up with working Libre Office and VLC video player and anything else you would frequently use from Windows.

To get normal stuff eg for watching videos that is not included because of unfree licenses you will need to follow guide here:

https://rpmfusion.org/

On Thu, 31 Jan 2019 17:53 DavidMc1948 <notifications@github.com wrote:

JDK installed.

I read that I needed to install python before installing Eclipse. So I did that.

I have downloaded Eclipse but having problems installing. I click on the Ooomph EclipseInstaller and get an "internal error" . I am asked if I want to do an update. I have done that a number of times but it does not help.

— You are receiving this because you authored the thread. Reply to this email directly, view it on GitHub https://github.com/Maksakovsky-admin/technical/issues/17#issuecomment-459236472, or mute the thread https://github.com/notifications/unsubscribe-auth/AGr2C57TqvL3RtMalVrc-GG9Ar8X7Qyuks5vIpLlgaJpZM4aCKSj .

DavidMc1948 commented 5 years ago

Installed Eclipse from the Fedora software shop.

dentarthur commented 5 years ago

Great! So familiarize with that.

The issue I raised with BaseX/oXygen/Eclipse/XQDT has now been resolved and closed with new documentation here:

https://github.com/BaseXdb/basex/issues/1656

You might want to try out Eclipse XML editors in the meantime, eg Vex.

Also there is an "Information Modeling" plug-in for Eclipse which removes visibillity of everything distracting from simple class diagrams.

To understand DITA, UML Information Modeling and Eclipse you might want to use the IM plugin to recreate this diagram:

https://stph.scenari-community.org/doc/lan/co/ditAP01_6.html

and compare with the concepts of 3 download links xml.zip and the two pdf files

NB Those are XML files which may look less ugly in Vex and MUCH more meaningful with oXygen, XMLmind or any XML editor configured with DITA scheamas including Vex.

We will be using less ugly LwDITA Markdown.

Note the diagram is simplified as maps can also be composed of maps as in the examples.

So you could also correct it.

PS I suspect we will be using JATS before DITA

On Sat, 2 Feb 2019 12:18 DavidMc1948 <notifications@github.com wrote:

Installed Eclipse from the Fedora software shop.

— You are receiving this because you authored the thread. Reply to this email directly, view it on GitHub https://github.com/Maksakovsky-admin/technical/issues/17#issuecomment-459920164, or mute the thread https://github.com/notifications/unsubscribe-auth/AGr2Czqe-irgVw7vYeFPOlBb7Y8hk6xhks5vJOdKgaJpZM4aCKSj .

DavidMc1948 commented 5 years ago

Giving up trying to install Vex into Eclipse. Just get error messages. Will try again in a few days.

dentarthur commented 5 years ago

Fair enough.

Eclipse is complex so easier to understand error messages after more familiar with Linux.

Better to familiarize through Pandoc. Will also run into problems but much more straight connection between inputs, command line, results and error messages so you can put them all online in same folder and I can help you figure them out.

On Wed, 6 Feb 2019 16:07 DavidMc1948 <notifications@github.com wrote:

Giving up trying to install Vex into Eclipse. Just get error messages. Will try again in a few days.

— You are receiving this because you authored the thread. Reply to this email directly, view it on GitHub https://github.com/Maksakovsky-admin/technical/issues/17#issuecomment-460902667, or mute the thread https://github.com/notifications/unsubscribe-auth/AGr2C7O76S_NWKtTuE41muJLJni_QEHRks5vKmMugaJpZM4aCKSj .

DavidMc1948 commented 5 years ago

Spending time with pandoc and atom at the moment.

Started drafting for CEA paper using atom.

dentarthur commented 5 years ago

Great!!!

On Wed, 6 Feb 2019 21:31 DavidMc1948 <notifications@github.com wrote:

Spending time with pandoc and atom at the moment.

Started drafting for CEA paper using atom.

— You are receiving this because you authored the thread. Reply to this email directly, view it on GitHub https://github.com/Maksakovsky-admin/technical/issues/17#issuecomment-460974554, or mute the thread https://github.com/notifications/unsubscribe-auth/AGr2C2kKL0BY5Ld4rYIliNLnUf9qWTjZks5vKq75gaJpZM4aCKSj .