Advertisement
Guest User

Untitled

a guest
May 2nd, 2016
50
0
Never
Not a member of Pastebin yet? Sign Up, it unlocks many cool features!
text 2.86 KB | None | 0 0
  1.  
  2.  
  3.  
  4. ## Write up pro tools doc
  5.  
  6. Pro tools has been discussed in terms of cnxml and providing an interface on
  7. publishing to accept cnxml in a completezip type format.
  8.  
  9. ### How does this look from a DMS Point-of-View?
  10.  
  11. The new DMS desk tool will have a web interface where the following will be true:
  12.  
  13. - Provide links to download the `.complete.zip` for any given content.
  14. - Provide links to download any resources associated with the content (e.g. the PDF).
  15. - Provide a means to upload a `.complete.zip` for publication,
  16. which will subsequently provide:
  17. - a means to view state and errors
  18. - a means to (optionally) preview the content as HTML before submission for publication
  19.  
  20. The DMS will download a `.complete.zip` of the content.
  21. They will edit/create the portions of the content that are needed.
  22. (It's implied that in order to work on the content they will unzip the file.)
  23. They will then zip up the contents of the work
  24. (a simple tool can be created to do this if necessary,
  25. but right click to 'Archive' should just work).
  26. Lastly, they will upload the edited and archived `.complete.zip` file
  27. to the DMS desk instance.
  28. This upload can either be done as a cli script or via the web interface.
  29.  
  30.  
  31. ### Why provide an interface to accept cnxml on publishing?
  32.  
  33. We have cli tools to transform cnxml to html,
  34. so let's use these to compile html and send the payload
  35. as a format publishing already accepts and acknowledges (i.e. internal epub).
  36.  
  37. 1. Acquire .complete.zip (from zope|publishing)
  38. 2. Work on content
  39. 3. Convert .complete.zip to .internal.epub
  40. 4. Send .internal.epub to publishing (for publication)
  41. 5. Repeat as needed
  42.  
  43. New development is now scoped to two areas:
  44. a tool to convert a `.complete.zip` to `.internal.epub`
  45. and
  46. an interface on publishing to produce a `.complete.zip`
  47.  
  48. The external tool is useful in this situation because we can quite litterally
  49. chuck it in to the digital forest when we are done with it.
  50. There it can bitrot and paradise. :)
  51. Also, as a separate tool, others (beyond cnx devs) can maintain it
  52. without having contextual knowledge of other parts of the system.
  53. And another thing,
  54. this does pre-validation of cnxml before submitting it to publishing.
  55.  
  56. Let's tentatively call this new tool, DMS desk.
  57.  
  58. Can a DMS run this tool locally?
  59. Sure.
  60. Do they have to run it locally?
  61. No, I think the approach here is to treat this new tool as an editor
  62. similar to cnx-authoring.
  63. It will communicate with cnx-publishing similar to how cnx-authoring does.
  64. In which case it will utilize the same mechanisms for error handling.
  65.  
  66. The publishing interface to produce a `.complete.zip` file
  67. should be relatively easy. I feel confident that making this small
  68. read-only change will not affect the cnx codebase in adverse ways.
  69. Additionally, the implementation of this interface can be done in two
  70. increments; proxy zope (immediate results) and later actually build the `.complete.zip`.
Advertisement
Add Comment
Please, Sign In to add comment
Advertisement