laws-africa/indigo

Indigo Platform for publishing beautiful legislation.

indigo's Issues

Find references to Acts

• find references
• update grammar to support round trip
• resolver to redirect user to act websites
• add resolver param to HTML renderer
• add Find links to Acts in Analysis toolbar
• release latest slaw and updated dependencies in indigo
• search for acts when first importing
• track resolver instances with zero matches
• setup references db with data

Work sidebar

• core sidebar
• colours
• sidebar links for document
• rename document sidebar
• make document sidebar use flex
• recent changes
• preview

Add login page

• remove login functionality from app views
• password reset flow
• require auth on app views
• require auth on api urls?

Bootstrap 4

• import page
• work pages
• library page
• password and profile box
• login page
• document page
• document page menus and submenus
• tooltips
• cheatsheet
• resolver
• use npm

Create a sandbox instance for people to play with

Saving a section and then re-editing loses changes

1. choose a section in the TOC
2. edit a section and click update
3. save the document
4. immediately click the section's edit button again (without clicking in the TOC)
5. make changes and click update
6. changes are lost

This happens because: when the document is saved the server sends updated XML. The DocumentContent model parser the new XML and stores it, and the TOC is rebuilt. However, the 'item-selected' event is not fired and the fragment linked to the editing view that we use to indicate which node must be updated with changes from step (5), is not updated. So the fragment now belongs to the old document object.

Use diff-match-patch to write only changed data back to server

For big documents, this is much faster.

We will need a way to identify what the base revision of the diff is. We can't use the revision id, since the latest version of the document doesn't actually have a revision id.

Amendments list can include amendments not applied to this version

Clarify whether these are all work amendments, or only amendments to this version. It should probably be only the latter.

Document permissions required to edit documents

• attachments - not required, depends on documents
• documents - required and obeyed
• works - required and obeyed
• annotations - required and obeyed

Make publication name pre-fillable

Provide a list of common publication names (eg. provincial gazette names), linked to a country.

Maybe also make it a combo-box, so that users can also add their own if the pre-filled list isn't sufficient.

JSON support for resolver API

This would allow callers to find published sources of documents.

Table import may be messing up colspan and rowspan

TOC URLs should reflect expression date

eg. https://indigo.openbylaws.org.za/api/za-cpt/act/by-law/2009/events/eng@2010-12-09/toc.json has URLs for without an expression date, which maps to the "latest" expression which is actually wrong.

As a power user I'd like to be able to download a zip archive of a document

UI should have a "Download as ZIP archive" menu option. Download should include:

• xml
• attachments
• html?
• pdf?
• epub?

Deprecate and remove the LIME editor

The editor is not used in AfricanLIIs indigo, is complicated to integrate, and out of date.

As an editor I want to be able to easily see the source document for a work

Cohesive mechanism for linking work and document attachments.

As a power user I want to be able to download a document as XML

Add a "Download as XML" to the document menu.

Currently I have to cut-and-paste from the XML view.

Support notices that are entirely schedules

eg. https://indigo.africanlii.org/documents/574/

AKN expects a non-empty body.

When viewing XML source, hide annotations

There's not enough room for everything otherwise.

Format SA regulation titles better

Regulation gnr698 of 2017 should be Regulation GN R698 of 2017.

As a user following a linked ref, I want to see works on a publishing partner's platform

TOC elements should be nested when editing a document

This helps navigate the hierarchy of long documents.

Improve table editing

Make this inline.

• use CK editor to strip bad tags
• table editor toolbar alignment
• use XSLT to transform HTML into AKN
• disallow editing of multiple tables at a time
• disable CKeditor toolbar
• support newlines in cells
• correctly handle cut and paste
• document

Make tracking of amendments simpler

It's currently complex to apply new amendments to an existing document. You need to ensure that the amending document is in the library, link to it, ensure you're editing the right one, etc.

Instead, treat a collection of expressions of a single work, and the linked amendments, as a logic model.

• show amendments and amended versions together
• make newly created doc FRBR URIs random
• ensure adding/editing/removing amendments works
• save all modified documents
• limit the choices of expression date
• keep unsaved amendments when creating a new expression (cloning doesn't include the at-date amendment)
• migration to make docs with generic import URIs random

Support minimising sidebar

Remember it between views?

Add menu interface

• more understandable
• opportunity to introduce new functionality more easily
• less clutter in sidebar

• ensure library and import pages work correctly
• icon
• make menu items work on hover

Menus

File

• Create a Copy
• Download As
• Recent changes
• Delete

Analysis

• defined terms

Upgrade Django to 1.10.1

Too early to upgrade to Django 1.11 LTS right now. But updating to 1.10.x would help make the upgrade to LTS easier later on.
Have tested Indigo with Django 1.10.1. Will start with this version, and upgrade to 1.10.6 if all things go smooth.
Major concern being the Third Party libraries/plugins.

Better default country and default language support

These are currently hardcoded in models/documents.py. If we make them mandatory, we don't need defaults. Or at the very least, move them into settings.

Basic server-side search support

Would be useful to do basic full-text search on the server.

• API
• filtering
• handle different document languages
• documentation
• Differentiate between search for published documents (returning only the most recent expression of a work), vs search across documents returning any matching document.

Enforce user (editor) must always have an associated country

BS4 improvements to document page

Make the document page more document focused by removing boxes and moving buttons into the button toolbar.

• fewer boxes on document page
• better button layout on document page
• move doc details into a modal, it's uncommon to change them
• make publish/draft a dropdown on the save menu
• move edit menu into toolbar, show only when applicable
• view/edit attachments in a popup
• improve revisions page

Support links in tables

Support UL in AKN, so that we can support the SA constitution

We've generated AKN for the constitution documents at myconstitution.co.za, but they contain UL lists, which the plaintext version of Indigo doesn't yet support.

Mistaken start of schedule

Indigo thinks the following starts a new schedule:

(2) Schedule 1 of the Public Enterprises Governance Act , 2006 (Act 2 of 2006), is amended by the insertion after item 52 of the following item:
"53 Communications Regulatory Authority of Namibia Communications Act , 2009 (Act 8 of 2009 )"
[Subsec (2) amended by sec 15 of Act 8 of 2015.]

Change it to

(2) The Schedule ...

fixes it.

Support works as a first-class entity, rather than implicitly in documents (expressions)

• model
• api
• migrations
• cascade soft deletes
• document view
• import view
• permissions
• add work view
• move commencement and assent dates completely to work
• edit work view
• new document flow
• prevent deletes when necessary
• library view
• prevent duplicate works
• repeal moved to work
• use work chooser when choosing repeal
• documentation
• use work chooser when choosing amendments
• link to works in document amendment view
• create work for amendments
• concrete amendments in work view
• copy over amendment info into documents as appropriate, when saved
• permissions on amendments in work view
• make document amendments readonly
• improve work amendment view
• document amendments must be readonly
• don't stash amendement_events in JSON on the document, pull from the work
• hard delete works

Support Rwandan numbering scheme

Both in parsing, and in display.

rwanda.pdf

Upgrade to Django 1.11

Django 1.10 support ended 2 December 2017.

When adding an amendment, Indigo should help me build the FRBR URI for documents not in the library

Make "commences on" and "assented to" not a heading so it's not a TOC entry in pdfs

ePub and PDF shouldn't rely on full bootstrap.min.css

• what do we really need? resets and basic component styling?
• just typography?

indigo_api/static/stylesheets/epub.scss and indigo_api/static/stylesheets/export.scss.

As a volunteer I don't want to do damage to countries I don't know about

Country-level permissions.

Support comments/annotations

Support annotations and/or free-form comments/replies.

• basics
• replies
• delete comment
• permissions
• edit comment
• markdown? parsing?
• resolve comment
• anchor must be scoped to the act or component/schedule
• comments for top-level elements with ids (eg. preamble)

Quick edit for schedule elements doesn't work

The quick edit uses querySelector('#...') which can be an invalid selector for ids in schedules which can look like schedule/section-4.1. We must

• handle scoping
• use [id=...] or similar rather than # which is too generic.

PDF versions of tables sometimes exceed width of page

eg. see https://indigo.openbylaws.org.za/api/za-cpt/act/by-law/2015/municipal-planning/eng.pdf

Support images

Perhaps use the Markdown inline syntax: ![alt text](/path/to/image.jpg)

Issues to be resolved:

• are images just attachments? Probably simplest mechanism.
• what image paths are used when rendering HTML?
• should image paths be relative to the document root, not the API root?
• how would an API user download images along with XML, etc?
• how to make this simple for editors, to upload and insert an image.
• pdf
• epub
• html
• server-side preview
• cheatsheet
• editing docs
• api docs

BUG: support links in remarks

eg.

[[S 3(1) subs by s 27 of [Act 33 of 2004](/za/act/2004/33).]]

Translate for spanish is possible

In transifex, i will translate to spanish

L10N: localise headings and keywords in PDF, HTML, etc. versions of Documents

This is about localising the output of the platform, not the platform itself.

For instance, for a Xhosa document this should change:

Provincial Notice 365 of 2011

Commences on 2 April 2012 unless otherwise noted 

• update HTML templates
• update XSLT stylesheets
• translate PDF Table of Contents
• translate Table of Contents generated on the server side
• mechanism to easily add new/maintain translations

Phrases to translate:

• chapter
• part
• Assented to on XX
• Commences on XX unless otherwise noted
• Amended by XX on XX
• Table of Contents
• Act
• By-law
• Provincial Notice

Use a cropbox to ignore some PDF content

Helps with columnar text, footers and headers.

• support --crop in slaw
• UI
• use poppler pdftotext

When importing a document, allow the user to choose the country

Otherwise the act auto-detection uses 'za' incorrectly.