LRNWebComponents / hax-body

CODE MOVED TO https://github.com/elmsln/lrnwebcomponents PROJECT HOME:
https://haxtheweb.org/
Apache License 2.0
55 stars 7 forks source link

Comment workflow for author collaboration #4

Open rickhumphries opened 6 years ago

rickhumphries commented 6 years ago

Following on from discussion in #3

For the comments workflow - we use Diigo (https://www.diigo.com) currently to collaborate by adding comments and highlights to the screen and that works in much the same way:

image image

So this works by highlighting some text initially - then a mini pop up appears allowing you to make the highlight, comment or search:

image

The only drawback with this method is the mini pop up tends to get in the way a lot when you're not actually wanting to comment on anything - so you might want to have a 'comment-mode' in the same way as you have an 'edit-mode' where that type of thing exists

btopro commented 6 years ago

Context for those joining thread. @rickhumphries 's group uses ELMS:LN and uses this to collaboratively discuss with other IDs / content authors. I've noticed other units at PSU doing weird stuff like color coding lines and then taking them out later or using <!-- legit HTML comments. It would be great while working on HAX to come up with a way that one could leave inline comments / have discussions with people about the content during production, peg that to a permission and then only show whatever it is when people have that permission.

Especially curious @profmikegreene & @kat-wehr experience w/ content producers / ID perspective if there's a lot of red underlining in word docs or if a light weight commenting solution would be beneficial during production but hidden from students at all times so we don't make an oppsie

kat-wehr commented 6 years ago

I feel like I've brought this up before so forgive if I'm repeating something that has been explored already, but something like the Genius Annotator would be fantastic. https://genius.com/Genius-how-to-use-genius-to-make-your-site-annotatable-annotated So the goal of that tool is for annotations to be available to all publicly, but it would be really nice to have this be private. I'm thinking like a google docs style discussion/editing without affecting the way the content appears to the non-designer/non-teacher.

On the flip, it would be cool for students to utilize something like this to do collaborative note taking and stuff. But I think the potential for ID-faculty conversations is much higher priority.

profmikegreene commented 6 years ago

Annotatable is a capability I think should be baked into the web, I fully support pushing it forward here. I'm hesitant to put any serious work on something that could be pulled out from under us. Diigo and Genius are closed products, although they have been around a good while, they worry me. Hypothes.is is an open option I'm aware of, I'm sure there are more.

Is the idea that content created by hax could be delivered inside a tag with annotation capabilities? Do you need to integrate with any system to make that happen?

btopro commented 6 years ago

I share your skepticism w/ integrating w/ anything that could disappear. To me this would have to be able to be locally hosted (and if it has the ability to be remote / quick setup then cool too). you need a backend to provide a storage mechanism and components to visualize it. Doesn't need to be HAX related though an authoring specific conversation could be HAX driven if needed.

on the hax side, this could basically be visualizing things commented out w/ the traditional HTML <!-- whatever here is commented out --> tag structure. This would allow commentary on paragraphs and things which is also portable. If it was a student discussion in context sorta deal ELMSLN has a system waiting for adoption that provides the backend if it was visualized correctly via components on the front end (again, sub out elmsln for anything that can accept comments :))

btopro commented 6 years ago

13 is now supported @rickhumphries so existing HTML comments won't be wiped. We'll want to make a tag for collaborating that's permission driven so people can't see it if they don't have access to that tag. This will be tied to the permission to view HAX in the first place. something like hax-author-comment or something which can references another comment. The menu for using this can live in the ... more menu on the UI and could associate to elements to outline them (like an image tag that needs a comment of "use a real image here" or to highlight part of a sentence and apply it just to the highlighted area.

42 is a blocking issue for this since we'd have to know we were between an inline element tag

btopro commented 6 years ago

similar internal logistical pattern as #102