Wishlist and Bugs

Bugs we ran into while working on the project

(feel free to add any bug you run into to this list)

• I noticed when working on the structure of the site and pads, that i ran out of numbers in a specific number space, it’s quite tedious to go through all pads and change the numbers, maybe a secondary numbering system could be useful? like 20.1 20.2 …?

• Would it be possible to add an edit view or button on the html page that brings you back quickly to the editing environment?

• It would be also be great to have ‘Regenerate’ button inside a publication and inside a chapter. Yes.

• is there a way to see the order of pads in the overview?

• Alix: how to deal with links when we make a physical publication? how to translate images or videos to a phyaical publication?

Bug list ordered by Gijs:

Big missions

• Give administrators of organisation ability to do user management (3 days)
  • Create, edit, delete or invite users
  • Open or close public registration
  • Password reset through mail for the users
  • Suggestion: (heerko) list the users of the organisation in the etherport backend?
• Separate file manager access per organisation (3 days)
• Rethink the pad-reference system, currently there are issues when pads have the same identifier (though there is no mechanism to warn the user about it), or the pad identifiers change. Solution could be to link to the more stable pad-id. Probably needs a more visual reference insertion method. But, not as relevant for etherport. (4 days ?)
• Allow to generate a publication for export. The publication is generated, but rather than it being part of the system the browser downloads a zip-file with the HTML-, CSS-, Javascript and mediafiles of the website. Which allows to place the website on a different server (~2 days, started on a recipe for INC. Need to work on including the media files and setting the base domain.)
• Backup / archive function: download .md and .etherpad format of pads in a publication at once (1 day)
• Adjust the ep_comments plugin for annotations rather than inserting the syntax into the pads. (2 days)

Medium

• Make the generation process more robust: failing on a pad should not crash the system. Perhaps report which pads broke with a link to them? (4 hours)
  • italics/bold etc in the meta data fields break the regeneration. (hour)
• Show an error message when a pad has the same slug. (1 hour?)
• Apply the breadcrumb navigation everywhere: currently pad renaming views don’t show breadcrumbs (2 hours)
• Show status of publication at the top of each pad, with a (re-)generate button. As to give insight into which version has been generated and to make regeneration easier. (2 hours)
• Community pad
• Show pad listing left to the etherpad editor to allow jumping between pads.
• Option to show a preview of the publocation in an iframe next to the pad when editing visual styles. Would work since CSS-changes do not require a regeneration.
• Upgrade the django version. (?)
• Clarify the place of the pads in the publiction through a view which lists the order of the pads. Much like a ‘spine’ in an epub. (2 hours)
• Snippets allow to insert content in specific places throughout a publication: for example a header or footer. Think of set of a snippets that would make sense for publications. Document them. (2 - 4 hours)
• Extend, and document options which can be set through the index pad. Move where these options are set? For example what is indexed. Which elements are used in a publication. (2 hours)
• Install a default set of paged.js plugins https://github.com/pagedjs/pagedjs-experiments
• italic/bold etc override the css style of headlines/captions etc
• Generating thumbnails while generating the static site. (2 - 4 hours)
• Work on manual / workshop script (4 hours)
• Improve the GUI of Publication overview (4 hours)
  • Jump links to organisations
  • Make listing more compact?
  • Make a separation per organisation between its, a bit like tabs:
    • publication
    • Visual Styles
    • Content templates
    • users

Smaller tasks

• Clarify relation between pads on front and back end. For example by adding an edit link on the front end, and a ‘show public page’ on the backend (latter might be more complex).
• Add a message above public pads, indicating it’s public, but also it’s address. (1 hour)
• Hide controls in the pad for people who are not logged in. (2 hours ?)
• Install etherpad plugins which move the caret after the metadata (1 hour)

Solved issues:

• Logins: Can organizations add users themselves? Yes, through the organisation page.

• Different levels of publicness of pads (shareability of editable pad links) ✔

• Differentiation (visually and structurally) of note pads (only visible online) and articles (visible online & pdf) ✔

• TOC: possible to add more information (author names, small abstracts), now its only titles of articles ✔

• 2nd level hierachy of menu (website), 1. chapter, 2. articles ✔