search

noamross / redoc

[NOTE: Project in suspended animation for now] Reversible Reproducible Documents
https://noamross.github.io/redoc
Other
514 stars 44 forks source link

Feature: Simple Documentation Addition, Use Case Itemize #72

Open statsccpr opened 4 years ago

statsccpr commented 4 years ago

First, like a lot of people are saying, this package would be a definite game changer. Especially since, you can now natively edit .docx thru google docs (without the previously .docx to google docs conversion)

I don't think it's brought up yet, looking at https://github.com/noamross/redoc/issues?q=example https://github.com/noamross/redoc/issues?q=docs+label%3Adocs

I'd like to request adding a simple itemized workflow in the 'Basic Usage' section, that's not present in the readme https://github.com/noamross/redoc

I'm guessing a lot of peoples workflow would be

1.. Start a .RMD doc 2.. knit .rmd to .docx 3a.. open .docx and enable track changes 3b.. edit in .docx and save 4a.. return to rstudio and absorb edits from 3b) via diff / dedoc / roundtrip 4b.. Clarify if 2 source async edits are possible: If i make edits in the RMD BEFORE 4a (call it 4a0), then absorb edits from 3b, will both the edits of 4a0 and 3b showup in the active document?

It is not clear to me if 3a is necessary. It is not clear to me if 4b works.

My hope is the itemized points like the above would sort what can and cannot be done so far

BTW, i think this would qualify for a lot of the google summer of code projects, especially with the new google docs .docx support

Thanks for the contribution

statsccpr commented 4 years ago

After experimenting more, it looks like 3a is optional, you can leave track changes toggled on or off

4a) in rmd dedoc works while roundtrip has an error

After experimenting, looks like the 2 source async edits do not work 0) rmd version 1 output a docx version 1 a) source 1 rmd edits (without knitting to docx version 1) b) source 2 docx version 1 edits c) back in rstudio, dedoc b to active file does not pickup change from step a but does pickup change from step b (tried toggling track changes on/off)

With this behavior, looks like the .rmd user has to wait until all the docx sub edits are set before dedocing back to the rmd --> then new rmd edits --> knitting to a new integrated docx

I guess this async feature would require the Rmd user to setup a git middleman to resolve any conflicts