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-15 19:55:22 +00:00
parent 1e82f3122c
commit c0da82f2ad
1 changed files with 67 additions and 38 deletions
Download Patch File Download Diff File Expand all files Collapse all files

105
ayanova/devdocs/todo.txt
View File

@@ -67,47 +67,76 @@ CURRENT TODOs
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
todo: WIKI VIEWER
- 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
research
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?