admin/raven-client
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Browse Source
This commit is contained in:
John Cardinal
2020-04-20 14:25:03 +00:00
parent 414d9cf51f
commit 7e420c8daf
1 changed files with 13 additions and 161 deletions
Download Patch File Download Diff File Expand all files Collapse all files

174
ayanova/devdocs/todo.txt
View File

@@ -65,168 +65,9 @@ CURRENT TODOs
@@@@@@@@@@@ ROADMAP STAGE 2:
todo: WIKI
todo: WIKI VIEWER
- Resides inside the corebizobject form
- make an alternate view that hides the editable elements temporarily
- make a sample doc to test with all elements required
- all formatting supported by standard and marked
- Remote and local attached images
- Edit button if have rights
- Download, open as pdf, email?
- Check the ability in v7 for wiki and see what can be supported
- basically it's just all the markdown stuff already doing and the rest is stuff that doesn't apply to markdown like colors, fonts etc
todo: Make an editor page
- https://rockfish.ayanova.com/default.htm#!/rfcaseEdit/2032
IMAGES
- easily add images https://rockfish.ayanova.com/default.htm#!/rfcaseEdit/2080
- both local and URL based images
- Local need some kind of chooser (or do we go with attached images attached to wiki object only?)
- People will just want to stick an image into the document
- Images are weird because they could be useful as an attachment anywhere but they are also something people put into a wiki to view inline
- So...need to think of them in two ways really.
todo: DATADUMP - v7 wiki to RAVEN markdown
- https://rockfish.ayanova.com/default.htm#!/rfcaseEdit/3468
- Need to export images and attached docs as attachments
.
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
............................
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?
Must support as much as my docs do
IMAGES
- easily add images
- both local and URL based images
- Local need some kind of chooser (or do we go with attached images attached to wiki object only?)
- People will just want to stick an image into the document
- Images are weird because they could be useful as an attachment anywhere but they are also something people put into a wiki to view inline
- So...need to think of them in two ways really.
Export to pdf? (or is that a reporting function?)
Markdown to PDF is probably a separate thing
Useful links
Markdown reference / standard: https://commonmark.org/help/
Markdown wysiwyg editor https://github.com/Ionaru/easy-markdown-editor
Vue wrapped wysiwyg editor (can use has a vue wrapper need to investigate practicality)
https://ui.toast.com/tui-editor/
markdown to html c# (.net core compatible) lib: https://github.com/Knagis/CommonMark.NET superseded by https://github.com/lunet-io/markdig
Fucking cool markdown to display VUE component which seems kind of ideal:
https://miaolz123.github.io/vue-markdown/
Live example demo: https://miaolz123.github.io/vue-markdown/
Supports everything I want including IMAGES! FTW!
EDITOR TEST ON MOBILE
a phone sucks for editing even when the editor works perfectly, kind of need to assume that mobile will not be used very much for editing
This is mostly due to the keyboard
I think the important thing will be uploading pictures and stuff more than editing wiki pages on a phone
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#
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/
Upload photo into wiki
- https://rockfish.ayanova.com/default.htm#!/rfcaseEdit/2080
DATADUMP - v7 wiki to markdown
- https://rockfish.ayanova.com/default.htm#!/rfcaseEdit/3468
In format that can be edited with RAVEN wiki editor (supports same elements)
------------------------ /WIKI ---------------------------
todo: wiki in datalist?
- will need for reports but can't show in a grid, maybe it's available for something but can't be seen or filtered?
- shows in grid as basically a bool like has wiki or not but doesn't show any actual wiki?
- this is only to feed report, no other purpose to it.
todo: document that emojis can be used in any text field and key combo on windows is winkey-period
-other os's too?
todo: make the navigation pane sticky so it remembers the last setting of hidden or showing in large view size
@@ -263,6 +104,7 @@ todo: ATTACHMENTS
- server should send the list of attachments on an object with the object as a read only property
- This way they can be displayed in the UI without another hit to the server and used for attaching wiki images etc etc
- Server needs route to get attached files from direct url without headers being set
- easy url for inside wiki and other places
- dl token I guess in url? Appended to image urls?
- is there a way at the client to intercept urls and change them to include the dl token?
- ability to rename file on upload https://rockfish.ayanova.com/default.htm#!/rfcaseEdit/3546
@@ -282,6 +124,11 @@ todo: AFTER ATTACHMENTS WIKI IMAGES
- baseurl setting for local images: https://marked.js.org/#/USING_ADVANCED.md#options
- in v7 images are not part of attachment system but rather embedded somehow in the document (have to refresh how that works for export dbdump)
todo: after attachments - DATADUMP - v7 wiki to RAVEN markdown
- https://rockfish.ayanova.com/default.htm#!/rfcaseEdit/3468
- Need to export images and attached docs as attachments
TODO: PRIORITIZE THE FOLLOWING BLOCK AND move INTO appropriate STAGES
@@ -457,8 +304,13 @@ Componentize of course
todo: DBDUMP Try to see if dbdump plugin can export reports code behind and basic layout, maybe as HTML, enough info to assist report designer with V8.
Be nice to see field list with translation for equivalent new.Also c# code exported and etc Can then get basic calculated field formulas that way, maybe a new report template with code Brought over as comments in JavaScript code behind for new and rudimentary layout of some kind
todo: REPORTING wiki Download, open as pdf, email?
- is this a reporting issue? I think it is, moving to reporting
todo: REPORTING wiki in datalist?
- will need for reports but can't show in a grid, maybe it's available for something but can't be seen or filtered?
- shows in grid as basically a bool like has wiki or not but doesn't show any actual wiki?
- this is only to feed report, no other purpose to it.
todo: Report editor for creating new report accessed from the report any **existing** reports preview form if have the rights.
- or maybe from the report selector dialog box if they have the rights, although would that fuck up navigation process?