diff --git a/ayanova/devdocs/todo.txt b/ayanova/devdocs/todo.txt index 92fe7870..d8076d0b 100644 --- a/ayanova/devdocs/todo.txt +++ b/ayanova/devdocs/todo.txt @@ -70,23 +70,63 @@ todo: WIKI Specs: - Most often people will view them rather than edit, so need viewing to be fast an easy - smaller payload to view + EDIT + - Fully support editing by entering plain markdown text + - Toolbar is simply to shortcut to enter the markdown text + - Make it easy to do with a phone by providing some way to easily enter the required characters as they are not present on the keyboard without dig + - Test on a phone early and often - Edit mode is a switch to edit kind of thing, not a normal process - switch to edit downloads a special payload for editing that is larger? - Insert images from url or from attachments to same object that wiki is attached to + - click into editor in desired location then select image + It should offer to link or upload image + - if link, just enter url and whatever, description etc required + - if upload then it should open a file picker and then it should both attach the image to the parent object as a file attachment and then create the image url markdown + DELETED IMAGES + - ideally, if they delete an image url it should ask if the attachment sb deleted if it's a local attached image + - or maybe if they save the wiki and exit it should automatically remove any attached images no longer referenced in the wiki? + - Or offer to do so + - Although, I kind of prefer that they manually have to delete them when no longer required as then there is no chance of accidentally deleting an image carelessly that + is still needed as an attachment + - ATTACHED images maybe need an extra flag indicating they are wiki images for automated orphan image handling etc + - Using attached local files as image source is also handy in that users can just view the images through attachments if it's a common reference thing and they don't need to open the whole wiki + + - When inserting local image, still uses same url based method as any image, just local url + - Need image route at server with rights and shit? + - or, if it's based on local object attachments anyway then sb fine because rights flow with object + - What if person deletes attached image being used by wiki from object? + - I guess this should be ok, just need maybe a warning that it's being used in the wiki or something? + - Deleted images in wiki should return a NOT FOUND or DELETED image as a placeholder - Global images available from anywhere?? - Could this work for logos and shit because I didn't really have any place to hang logos off of before but this makes sense but needs some thinking about how to UI it - VIEWER to edit mode - saw on one that they put a persistent pencil corner icon for going to edit mode, maybe could use a FAB or something for editing to decrease wasted screen space? - although, will need print and other shit probably so maybe will still need the toolbar menu anyway - + - HELP DOCS + - Link to commonmark site standard and link to their tutorial which is pretty cool - IMMEDIATE TODO FOR THIS ITEM: + + + research - Evaluate the options Payload size works responsively? pros and cons for building my own vs purchase (seems relatively easy to build the editor but who knows) The pre-made ones use codemirror (they all do), if I need codemirror for something else (DSL MACROS STUFF?) then does it make more sense or...? - + - How badly do I need to use a 3rd party markdown editor, considering it really is just a shortcut to entering the markdown text which I could do myself + - The table copy and paste thing toast shows is pretty cool, copied from excel and pasted into markdown + - maybe that's not super hard to support myself or the plugin code could be examined and modifed? + - some of them modify the displayed editor text to show / hint at what the preview would look like, but is that really necessary? + + Render markdown: + MARKED library + Examples using Marked + https://vuejsfeed.com/blog/minimal-vue-js-markdown-editor + https://codepen.io/leetrunghoo/pen/ZWEgew + https://codepen.io/Paolo-Duzioni/pen/EwYooo A bit fancier than the above + https://codesandbox.io/s/github/vuejs/vuejs.org/tree/master/src/v2/examples/vue-20-markdown-editor?from-embed=&file=/index.html official! + + Edit wiki from RAVEN - https://rockfish.ayanova.com/default.htm#!/rfcaseEdit/2032 Need markdown editor that's responsive or build my own? @@ -121,14 +161,20 @@ todo: WIKI https://nhn.github.io/tui.editor/latest/tutorial-example01-editor-basic - works, -https://easymde.tk/ -works but same issues as above, not as sophisticated -https://vuejsexamples.com/vue-markdown-editor-component-for-vue-js/ -same, works not sophisticated as toast -https://stackedit.io/app# -https://f-loat.github.io/vue-simplemde/dist/demo.html -https://simplemde.com/ -https://commonmark.org/ + https://easymde.tk/ + works but same issues as above, not as sophisticated + https://vuejsexamples.com/vue-markdown-editor-component-for-vue-js/ + same, works not sophisticated as toast + https://stackedit.io/app# + crappy, no toolbar ui could make that myself + + https://f-loat.github.io/vue-simplemde/dist/demo.html + same as others, but I kind of like it better for some reason + + https://simplemde.com/ + Goes absolutely snaky on mobile when attempt to highlight a word to change settings + + https://commonmark.org/ @@ -142,6 +188,9 @@ https://commonmark.org/ +------------------------ /WIKI --------------------------- + + todo: ATTACHMENTS - ability to rename file on upload https://rockfish.ayanova.com/default.htm#!/rfcaseEdit/3546 - stuff https://rockfish.ayanova.com/default.htm#!/rfcaseEdit/3484