nprapps / annotations Goto Github PK

This is a good chance to walk through the server setup process, so that we're not using the same box for liveblogs and this (making it easier to do both at once, god help us). We will need to:

• start a new instance with the correct AWS grants
• import someone's Google creds to serve as the basis for the authentication
• configure and generate a SystemD config file
• bring over the convenience shell functions (like logcat) from the liveblog and elections boxes
• document this process or update any existing docs

Some considerations:

• on the standalone page, we can support a floating "new annotations" bar the same way we do for the liveblog. On embedded pages, that will need to be at the top.
• Embedded page can use Sidechain, and should probably have a test page that we can send to stations with Pym/Sidechain embed codes. We should also generate a Sidechain host bundle for embedding pages.
• Some links may need to be handled specially for the embedded pages, since they need to dispatch to the host page instead of navigating directly.

Process:

• select a chunk of text for annotation
• open a panel to select author for the annotation and maybe other metadata? Do not allow custom slugs
• generate an auto-incrementing annotation ID
• convert the selected text into a link for that ID
• insert a new annotation after the current paragraph with a matching ID
• move the cursor into the annotation

Ideally, let's use the same author dictionary format as the current liveblog rig. Like that rig, we will need an additional menu item to change the dictionary to a custom spreadsheet ID.

When an annotation is added, even if published is set to false, the annotated text is highlighted. We should hide that link until the associated annotation is published.