In-browser place editor off master #620

goldpbear · 2017-02-09T04:54:38Z

Addresses: #401, #410, #438, #497, #498, #499, #500, #501, #523, #525.

Not ready to merge yet

Features added:

Place detail view editor mode for authenticated users
- By default, edit mode will make it possible to edit form fields that were filled out by the submitter as well as form fields for which the submitter provided no response
Geometry editing capabilities
- Geometry editing support is provided by a new form field type called geometryToolbar. If a category has a form field of this type in it, geometry editing functionality will be available
Rich text support via Quill
- To make a form field rich text-enabled, use the type: richTextarea flag in the field's configuration
Embedded image uploads
- Clicking the Quill image button will trigger an attachment upload and will insert an <img> tag inside the rich text field with the src attribute set to the uploaded image url
- Note that images attached via Quill are just regular place model attachments. This means that they will be displayed above any form fields in a place detail view, as this is the default behavior for places. To prevent this from happening, use the suppressAttachments: true flag in a category's config
Image manipulation
- Embedded images can be resized by clicking on them and dragging resize handles
- Embedded images can be moved by dragging them within the Quill interface
Localstorage-based "draft mode" for automatically saving in-progress editor changes client side
Admin-only form categories and admin-only form fields
- To make a category or form field admin-only, add the following keys to either the category config or the field config, as appropriate:
```
admin_only: true
admin_msg: _((For administrator use only))
```
  Note that currently admin-only categories and fields are admin-only strictly at the UI level: because new places generate POST requests, there are no corresponding backend checks to ensure that submissions from admin-only categories or submissions containing admin-only fields actually come from administrators.
Form-only fields
- Add a form_only: true to a form field's config to prevent the value of that field from appearing in place detail views. The value of form-only fields will still be sent to the client (unlike the values of private fields).

To enable the editor mode for a dataset:

In the Django admin panel, click on Data sets and then the name of the dataset you'd like to enable editing for.
Under the Groups section, create a new group called administrators if it doesn't already exist. Note that this group must be called administrators.
Add users to whom you'd like to grant editor privileges by selecting the user in the Available submitters panel and clicking the right arrow to move them to the Chosen submitters panel.
Click Edit permissions below the submitters panels, and grant retrieve, create, update, and destroy privileges. Also make sure that a * character is entered in the text box at left. The help text in the admin panel suggests that this box can be left blank, but this is in fact not true.
Click Save.
Now when any of the Chosen submitters are logged in via a social auth, an edit button will appear on place detail views that belong to datasets where they have edit privileges.

Note that it is possible to add new users to an administrators group even if they haven't already logged into the app via a social service. In the admin panel, click Users, then Add user +, then create a new user. The username must match the social service handle of the person you'd like to grant administrator access to. Then, in the User social auths panel, click Add user social auth +, select the user you just created under User, enter the name of the social service provider (twitter or facebook), then enter the social user's Uid. The Uid can be looked up online: here for twitter, and here for facebook.

Passing the reset option seems to elimiate the problem of directly-loaded landmarks causing a portion of the map to initially not be rendered and the center of the map to be displayed incorrectly. Fixes: #504

Make sure we reset the dynamic form state if we navigate away from a rendered form (say, to the list view). Otherwise, it's possible to corrupt the form's state by returning to the form after navigating away.

- support places with landmark-style urls - reduce code duplication in AppView - slight loading performance boost on direct url loads Addresses: #527, #549

This commit adds the following functionality: - Polygon and linestring geometry creation via the dynamic form - Polygon and linestring geometry editing via the detail view editor - Geometry fill and opacity control It introduces dependencies on: - The Spectrum jQuery colorpicker library - The leaflet-draw plugin Addresses: #410

- Move lib and css files out of old sa_web folder - Fix merge errors

…currentUser credentials

…cting with other on destroy listeners

…e in-browser editor

zmbc

Overall, looks good. Willing to help with the README stuff if necessary.

zmbc · 2017-04-30T20:03:51Z

README.md

-<DATASET-ID>_SITE_URL=https://path/to/dataset/
-<DATASET-ID>_DATASET_KEY=dataset_key
+DATASET-ID_SITE_URL=https://path/to/dataset/
+DATASET-ID_DATASET_KEY=dataset_key


You'll have to merge this change with the new README. Also, can you explain the thinking behind removing the angle brackets?

I can't quite remember why we decided to remove the angle brackets, although I do remember having a discussion about it at some point. Do you think it's better to leave them in?

zmbc · 2017-04-30T20:07:03Z

README.md

@@ -104,6 +104,30 @@ NOTE: If you're new to programming with virtualenv, be sure to remember to activ
 source env/bin/activate
 ```

+### Using the in-app editor
+
+The platform includes an in-app editor (currently only available on the `develop` branch) that you can use to update and hide places and comments on a per-dataset basis. Only authenticated administrators are allowed to make edits. Authentication is performed via third-party social media services (Twitter and Facebook are currently supported), so administrators will need an account on either of these services to use the editor.


You probably don't need to tell them which branches it's on, because your README change will be on those same branches.

Also, as before, you'll need to merge this into the new README. This new section should be under the Usage subheading, because its intended audience is users. Take a quick look at this to make sure you're following it.

zmbc · 2017-04-30T20:09:57Z

src/base/jstemplates/pages-nav.html

+<nav class="list-toggle-nav">
+  <a class="list-toggle-btn btn btn-block">
+  	<span class="show-the-map is-visuallyhidden">{{ show_map_button_label }}</span>
+  	<span class="is-screen-reader-text">/</span>


Why is the / screen-reader-text?

This block of code was relocated from base.html as-is. It already had that slash, and I'm not totally sure why. Maybe just so the screen reader span has some content in it?

zmbc · 2017-04-30T20:11:04Z

src/base/jstemplates/place-detail-edit-bar.html

+<!-- Template for the row of editor buttons visible at the top of place
+    detail views. -->
+
+{{#if isEditable}}


I'm not sure about this, but maybe this #if should be outside the template (wrapped around the template's use).

I debated this as well. My reasoning for having the {{#if}} check inside the template here is that the check is integral to the way this template should behave. In other words, there's (currently, at least) no situation where we'd want to render this template without the {{#if}} check.

zmbc · 2017-04-30T20:15:22Z

src/base/jstemplates/place-detail.html

+               class="place-value place-value-{{ name }}" 
+               alt="{{ name }}" />
+          <!-- {{#if ../isEditingToggled}}


Why is this commented out?

zmbc · 2017-04-30T21:36:34Z

src/flavors/duwamish_flavor/config.yml

            - id: vision
              title: _(Community Vision)
-              visibleDefault: false
+              visibleDefault: true


zmbc · 2017-04-30T21:37:11Z

src/flavors/duwamish_flavor/config.yml

@@ -997,6 +1020,50 @@ place:
          display_prompt: _( )
          placeholder: _(Enter description...)
          optional: false
+    - category: featured_place


Should this be here?

zmbc · 2017-04-30T21:37:23Z

src/flavors/duwamish_flavor/config.yml

@@ -1027,8 +1096,20 @@ place:
            - label: _(Other)
              value: other
          optional: true # NOTE: checkbox_big_button inputs have no validation
+        - name: reside_work_georgetown


zmbc · 2017-04-30T21:37:34Z

src/flavors/duwamish_flavor/config.yml

@@ -1048,8 +1129,8 @@ place:
          placeholder: _(Enter title...)
          optional: false
        - name: description
-          type: textarea
-          prompt: "_(What's your question?)"
+          type: richTextarea


zmbc · 2017-04-30T21:38:56Z

src/sa_web/jstemplates/geometry-style-panel.html

@@ -0,0 +1,8 @@
+


Why is sa_web here at all?

…metry correctly

…ail views

… saved

goldpbear force-pushed the browserEditor-401 branch 3 times, most recently from f693204 to 7edc654 Compare February 16, 2017 06:38

goldpbear added 11 commits February 22, 2017 12:34

Pass reset: true option to map.fitBounds() and map.setView()

e29f007

Passing the reset option seems to elimiate the problem of directly-loaded landmarks causing a portion of the map to initially not be rendered and the center of the map to be displayed incorrectly. Fixes: #504

Call resetFormState() in PlaceFormView on route events

73b7879

Make sure we reset the dynamic form state if we navigate away from a rendered form (say, to the list view). Otherwise, it's possible to corrupt the form's state by returning to the form after navigating away.

correct basemap layers in duwamish_flavor config

5740315

Refactor place/landmark loading

98f1569

- support places with landmark-style urls - reduce code duplication in AppView - slight loading performance boost on direct url loads Addresses: #527, #549

detect if category is selected in place form view postRender()

53d8b0e

update configs after large rebase to master

de2c908

Merge branch 'browserEditor-401' into polygonEditor-410

7e4d7c0

Numerous changes after merge with browserEditor-401

faf1f53

- Move lib and css files out of old sa_web folder - Fix merge errors

geometry editor updates

9fd6826

add onExpandCategories method back to PlaceFormView

17ebf95

goldpbear added the in progress label Mar 3, 2017

goldpbear force-pushed the browserEditor-401 branch 2 times, most recently from 501fb2a to 5a80e06 Compare March 6, 2017 03:44

goldpbear force-pushed the browserEditor-401 branch 2 times, most recently from 62ca4d9 to d83cf19 Compare March 16, 2017 18:20

goldpbear force-pushed the browserEditor-401 branch from c8ae47a to be9d1b3 Compare March 24, 2017 03:02

goldpbear added 10 commits March 27, 2017 11:16

add basic editor mode to place detail views, based on S.bootstrapped.…

0b3f7c0

…currentUser credentials

add a basic editor mode toggle button

290e72a

do not attach X-SHAREABOUTS-KEY header when HTTP method is PUT or DELETE

7022d1d

add delete post functionality

a3b5c9c

use a custom event to trigger user deletion of model, to avoid confli…

6f4e7c0

…cting with other on destroy listeners

fix an issue where ghost markers remain after deleting a place via th…

4783f47

…e in-browser editor

add remaining input types to editor mode functionality

a11e073

support new image uploading in editor mode

7dc77ae

use location_type for category name in binary toggle handler

201ed59

support updating comments in editor mode

a1a03b3

goldpbear self-assigned this Apr 30, 2017

zmbc requested changes Apr 30, 2017

View reviewed changes

goldpbear and others added 5 commits April 30, 2017 16:24

remove sa_web remnants

5c2956d

syntax improvements, small changes

d57ffae

Merge branch 'master' into browserEditor-401

ee7d043

syntax improvements, style improvements, consistency improvements

d1dcf24

update duwamish config with dataset for editor demo

e2c8cce

goldpbear force-pushed the browserEditor-401 branch from 1d97135 to e2c8cce Compare May 4, 2017 20:30

goldpbear added 5 commits May 4, 2017 18:07

fix a bug where colorpicker reposition listeners get bound too early

0d7f64f

fix a bug where clicking on the colorpicker doesn't reset working geo…

4b821ca

…metry correctly

fix a couple bugs that cause incorrect prompts to render in place det…

ca92914

…ail views

change canonical name of polyline geometry to LineString for consistency

f8f560a

fix a bug where using the colorpicker causes geometry edits to not be…

a32b5c1

… saved

goldpbear force-pushed the browserEditor-401 branch from eceb00a to a32b5c1 Compare May 5, 2017 18:53

goldpbear added 10 commits May 10, 2017 09:43

fix a bug where Quill popup tools sometimes aren't visible

1013786

add 'is published' toggle feature

34cfea7

remove an unneeded onChange listener in place-detail-view.js

d117e1a

prevent default form submission behavior on editor mode title form

61318ab

change 'hide this post' to 'remove this post'

ecaf47d

fix a typo

09381d3

update lakewashington flavor with editor features

52bd43e

fix a bug where selecting a marker and not placing it causes and error

25bb8cf

revert to hamburger expansion icon in dynamic form

8ce176d

update editor UI text

2714b67

goldpbear force-pushed the browserEditor-401 branch from 36a947c to 2714b67 Compare May 15, 2017 01:46

update README editor instructions

e5b5b13

goldpbear force-pushed the browserEditor-401 branch from bf3fd07 to e5b5b13 Compare May 15, 2017 02:31

goldpbear added 2 commits May 14, 2017 22:19

update pboakland flavor for editor

fd97465

update list view to work with the editor

9439e8b

goldpbear merged commit 80ce8f0 into master May 15, 2017

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

In-browser place editor off master #620

In-browser place editor off master #620

goldpbear commented Feb 9, 2017 •

edited

Loading

zmbc left a comment

zmbc Apr 30, 2017

goldpbear May 3, 2017

zmbc Apr 30, 2017

zmbc Apr 30, 2017

goldpbear May 3, 2017

zmbc Apr 30, 2017

goldpbear May 2, 2017 •

edited

Loading

zmbc Apr 30, 2017

goldpbear May 2, 2017

zmbc Apr 30, 2017

zmbc Apr 30, 2017

zmbc Apr 30, 2017

zmbc Apr 30, 2017

zmbc Apr 30, 2017

In-browser place editor off master #620

In-browser place editor off master #620

Conversation

goldpbear commented Feb 9, 2017 • edited Loading

zmbc left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

goldpbear May 2, 2017 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

goldpbear commented Feb 9, 2017 •

edited

Loading

goldpbear May 2, 2017 •

edited

Loading