.odt support #261

twiss · 2014-12-14T13:22:02Z

WIP. This is an effort for editing odt files (#108) with designMode. I'm sending this PR early on in case you really dislike the approach re #204.

This is on top of #246, although that isn't really a requirement.

ferndot · 2014-12-14T22:08:07Z

Yay! We have needed new format support for a while. If it is easier to work with designMode, then let's do that. I wanted to use WebODF simply because it seemed better suited to xml documents.

So, I tested, and encountered the following issues:

ODT files are not shown in the file browser
Manually loading an ODT file produces the following errors:

17:02:45.591 "Loading modules/editor/editor.html" "
    at app.modules.load (app://4c959139-b9c0-3146-adf3-1f1a7a8ef8e7/scripts/modules.js:126:3)" modules.js:126:3
17:02:48.274 "Finished loading modules/editor/editor.html" modules.js:137:8
17:02:49.532 "setSend" undefined Window → app://4c959139-b9c0-3146-adf3-1f1a7a8ef8e7/index.html docIO.js:8:51
17:02:49.533 "setRecv" undefined Window → blob:app://4c959139-b9c0-3146-adf3-1f1a7a8ef8e7/51f61524-3104-408c-837b-51cea91afa95 docIO.js:8:51
17:02:49.888 "setSend" undefined Window → blob:app://4c959139-b9c0-3146-adf3-1f1a7a8ef8e7/51f61524-3104-408c-837b-51cea91afa95 messages.js:47:2
17:02:49.888 "setRecv" undefined Window → app://4c959139-b9c0-3146-adf3-1f1a7a8ef8e7/index.html messages.js:70:2

Again, thank you for working on this 👍

twiss · 2014-12-14T23:05:01Z

If it is easier to work with designMode, then let's do that. I wanted to use WebODF simply because it seemed better suited to xml documents.

Well, it's not easier, no. The two main reasons are that 1) a consistent editor for all formats is nice and 2) on mobile, designMode currently works slightly better than WebODF.

ODT files are not shown in the file browser

Hmm, this should've done that, shouldn't it? Maybe FFOS doesn't know about .odt files.

Manually loading an ODT file produces the following errors:

That's part of #246, which does throw a lot of errors in some cases, but those aren't errors. Are you able to load html files?

ferndot · 2014-12-15T03:16:44Z

It appears that Firefox OS does not work with odt files. I have filed a bug at: https://bugzilla.mozilla.org/show_bug.cgi?id=1111427.

I am able to load HTML files. The ODF took a long time to load, so I jumped the gun a bit.

twiss · 2014-12-16T02:45:07Z

Conversion from and to odt now works for very simple odt files. I'll make a list of as of yet unsupported features in #108, feel free to point out more.

In case you ever want to add features, a little explanation:

The most important thing about handling odt files is that we don't lose data or corrupt files. So while we will always attempt to display the file, we will only allow the user to edit it if we're going to generate a valid odt file, i.e., we check that odt -> html -> odt yields the original odt. Of course, this doesn't cover user-generated html.

This means that while developing, that check will complain, a lot. But as Haskellers like to say, once it runs at all, it's also probably correct.

ferndot · 2014-12-16T15:00:02Z

modules/editor/scripts/docIO.js

@@ -5,30 +5,267 @@

 'use strict'

-function initDocIO(doc, messageProxy, loadCallback) {
+var ODTDocument = function(odt) {


Could you put this function in a new odt.js file in /scripts/parsers?

ferndot · 2014-12-16T15:20:49Z

Fantastic work @twiss. I just tested your patch on one of my research papers, and it displayed the ODT surprisingly well.

One idea that I had: do you think that we should split the ODT parser into its own repository, and include it as a git submodule? I feel that it would be very useful to other app developers.

ferndot · 2014-12-16T15:26:08Z

scripts/modules.js

+							var name = element.tagName;
+							if(name === "SCRIPT" ? element.src : element.href) {
+								var type = element.type;
+								var url = new URI(name === "SCRIPT" ? element.src : element.href, new URI(location.href)).toString();


I removed URI.js in 89e14d8

Yes, it won't be trivial to merge this as it is now. Though I'll split out these changes, they aren't needed for this anymore.

ferndot · 2014-12-16T22:16:03Z

Well, it's not easier, no. The two main reasons are that 1) a consistent editor for all formats is nice and 2) on mobile, designMode currently works slightly better than WebODF.

Hmm, my concern is that designMode does not support all the features of the ODT format. How can we address that issue?

The most important thing about handling odt files is that we don't lose data or corrupt files. So while we will always attempt to display the file, we will only allow the user to edit it if we're going to generate a valid odt file, i.e., we check that odt -> html -> odt yields the original odt. Of course, this doesn't cover user-generated html.

That sounds like a very good approach.

ferndot · 2014-12-16T22:20:11Z

As an aside, I wonder if web components will be useful for developing editors. E.g. instead of converting an XML file to HTML to use designMode, we could just use the existing tags as custom elements.

twiss · 2014-12-16T22:59:20Z

Hmm, my concern is that designMode does not support all the features of the ODT format. How can we address that issue?

Do you have specific examples?

As an aside, I wonder if web components will be useful for developing editors. E.g. instead of converting an XML file to HTML to use designMode, we could just use the existing tags as custom elements.

WebODF does that, sort of: they keep the odt tags as they are, and implement editing themselves on top of that.

ferndot · 2014-12-17T02:29:28Z

Do you have specific examples?

Pagination and annotations are two major features. designMode also does not support headers, footers, and page numbering, and the resizing handles are unwieldy. Do you think that we could implement those features on top of designMode?

twiss · 2014-12-17T11:18:10Z

Pagination

is hard. It is possible with CSS Regions, but that's deprecated and only supported in Safari.

and annotations

the tricky thing with annotations and footnotes is that they are a paragraph inside a span, which is not allowed in html. That's one advantage of WebODF's approach. Other than that, and figuring out how to correctly position them, I don't see fundamental problems.

are two major features. designMode also does not support headers, footers, and page numbering,

Haven't looked into this much. There seems to be some kind of support for displaying an element on every printed page, don't know if all browsers support this though.

and the resizing handles are unwieldy.

Worse, Chrome doesn't have any resize handles at all. Yeah, if you wanted, you could probably create something in js.

ferndot · 2014-12-27T16:06:40Z

Once we merge this, I'd like to make a new release of Firetext. Does that sound good?

twiss · 2014-12-28T00:38:40Z

Sounds good. It'll still take a while though, as html->odt is not far along yet. If you want to merge sooner rather than later, the easiest way to do that would be to disable (html) paste (and, for even sooner, the toolbar).

ferndot · 2014-12-28T00:51:43Z

Hmm, maybe we could implement a readonly mode and then activate it for ODT right now.

twiss · 2014-12-28T03:49:06Z

Hmm, maybe we could implement a readonly mode and then activate it for ODT right now.

Yep, also possible.

One idea that I had: do you think that we should split the ODT parser into its own repository, and include it as a git submodule? I feel that it would be very useful to other app developers.

Done: https://github.com/twiss/odt2html2odt.

twiss · 2015-01-09T03:25:03Z

What I do now is immediately undoing every change that we don't support. Is that ok with you? It's not very friendly, but it seems to work. Also,

ODT files are not shown in the file browser

Fixed.

ferndot · 2015-01-10T03:47:05Z

What I do now is immediately undoing every change that we don't support. Is that ok with you? It's not very friendly, but it seems to work.

Hmm, could we alert the user about it and hide the toolbar item?

twiss · 2015-01-10T04:06:46Z

You mean in addition to undoing? We could put an error message somewhere
(maybe overlay over the document?), that wouldn't make it much less
annoying though.
Currently we hide the entire toolbar, since we don't support most of the
things in there (only maybe tables and ordered lists).
Op 10 jan. 2015 04:47 schreef "Joshua Smith" [email protected]:

What I do now is immediately undoing every change that we don't support.
Is that ok with you? It's not very friendly, but it seems to work.

Hmm, could we alert the user about it, and hide the toolbar item?

—
Reply to this email directly or view it on GitHub
#261 (comment).

ferndot · 2015-01-10T04:13:34Z

Yup, in addition to undoing. Although, if the user cannot make any unsupported changes (the toolbar is hidden), a console.log with the error might be sufficient.

twiss · 2015-01-10T04:23:00Z

Well, they can, through copy and paste (and drag 'n drop, ctrl-b, and bugs
in odt2html2odt, although those things should also just be fixed in
odt2html2odt).
Op 10 jan. 2015 05:13 schreef "Joshua Smith" [email protected]:

If the user cannot make any unsupported changes (the toolbar is hidden),
then maybe a console.log with the error is sufficient.

—
Reply to this email directly or view it on GitHub
#261 (comment).

ferndot · 2015-02-10T02:35:27Z

Ready to merge?

.odt support

twiss force-pushed the odt branch from df5ecaf to 8bbfe1c Compare December 16, 2014 02:01

twiss mentioned this pull request Dec 16, 2014

.odt support #108

Open

ferndot reviewed Dec 16, 2014
View reviewed changes

twiss mentioned this pull request Dec 16, 2014

Move styles in editor.html to external file #262

Merged

ferndot mentioned this pull request Dec 16, 2014

[HTML editor] Move styles into an external file #253

Closed

twiss force-pushed the odt branch 3 times, most recently from d017d99 to 0d5364c Compare December 21, 2014 00:19

twiss force-pushed the odt branch 4 times, most recently from b0b8de1 to 99dc95f Compare January 9, 2015 03:12

twiss force-pushed the odt branch from 99dc95f to 8326347 Compare January 10, 2015 01:36

ferndot added this to the v0.4 milestone Feb 4, 2015

twiss force-pushed the odt branch from 8326347 to 99b3b1a Compare February 8, 2015 14:59

.odt support

d2bb37e

twiss force-pushed the odt branch from 99b3b1a to d2bb37e Compare February 8, 2015 15:00

twiss added a commit that referenced this pull request Feb 10, 2015

Merge pull request #261 from twiss/odt

ec6ff29

.odt support

twiss merged commit ec6ff29 into codexa:develop Feb 10, 2015

twiss deleted the odt branch February 10, 2015 03:02

ferndot mentioned this pull request Feb 10, 2015

[Investigate] WebODF editor #189

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

.odt support #261

.odt support #261

twiss commented Dec 14, 2014

ferndot commented Dec 14, 2014

twiss commented Dec 14, 2014

ferndot commented Dec 15, 2014

twiss commented Dec 16, 2014

ferndot Dec 16, 2014

ferndot commented Dec 16, 2014

ferndot Dec 16, 2014

twiss Dec 16, 2014

ferndot commented Dec 16, 2014

ferndot commented Dec 16, 2014

twiss commented Dec 16, 2014

ferndot commented Dec 17, 2014

twiss commented Dec 17, 2014

ferndot commented Dec 27, 2014

twiss commented Dec 28, 2014

ferndot commented Dec 28, 2014

twiss commented Dec 28, 2014

twiss commented Jan 9, 2015

ferndot commented Jan 10, 2015

twiss commented Jan 10, 2015

ferndot commented Jan 10, 2015

twiss commented Jan 10, 2015

ferndot commented Feb 10, 2015

.odt support #261

.odt support #261

Conversation

twiss commented Dec 14, 2014

ferndot commented Dec 14, 2014

twiss commented Dec 14, 2014

ferndot commented Dec 15, 2014

twiss commented Dec 16, 2014

ferndot Dec 16, 2014

Choose a reason for hiding this comment

ferndot commented Dec 16, 2014

ferndot Dec 16, 2014

Choose a reason for hiding this comment

twiss Dec 16, 2014

Choose a reason for hiding this comment

ferndot commented Dec 16, 2014

ferndot commented Dec 16, 2014

twiss commented Dec 16, 2014

ferndot commented Dec 17, 2014

twiss commented Dec 17, 2014

ferndot commented Dec 27, 2014

twiss commented Dec 28, 2014

ferndot commented Dec 28, 2014

twiss commented Dec 28, 2014

twiss commented Jan 9, 2015

ferndot commented Jan 10, 2015

twiss commented Jan 10, 2015

ferndot commented Jan 10, 2015

twiss commented Jan 10, 2015

ferndot commented Feb 10, 2015