OpenTechStrategies / torque

A flexible web-based open source system for collaboratively evaluating proposals.

1 stars 2 forks source link

Allow editing of specific fields in torque through mediawiki interface #41

Closed Nolski closed 3 years ago

Nolski commented 3 years ago

Overview

In #32 we describe that it may be useful for users to be able to edit fields which are contained in torque through the mediawiki UI. This PR adds the ability to do so through a basic inline textbox edit interface.

Screenshots

screenshot_2020-08-13-170626 screenshot_2020-08-13-170650 screenshot_2020-08-13-170700 screenshot_2020-08-13-170714

Features

[x] Inline editing of paragraph and list elements
[x] Logging of edits within Special:Log
[x] Separate database of edits to be rolled back in the future

This PR doesn't include a few things however such as

[ ] An interface for comparing edit diffs and reverting edits
[ ] Specific functionality only allowing certain users to edit certain fields

Nolski commented 3 years ago

@frankduncan Apologies, it looks like my editor auto-flake8'd the routes and init.py files. Do we conform to any sort of standard with our python files?

frankduncan commented 3 years ago

@Nolski None, and as you can tell, my switching between php and python quickly leads to some insanity. If you know of a good python style checker, that would be great to add.

Nolski commented 3 years ago

@frankduncan Feel free to have a look now. I suggest we go with black It's maintained by the python software foundation and seems to have had a lot of thought go into it. I'll add a formatting commit so you can see the logic diffs vs formatting diffs.

Nolski commented 3 years ago

@frankduncan

I think the only major change, not in line, is that right now, we still have a lot of code to handle the value replacing the html directly, and then refreshing over top of it. We should probably remove that and replace it with a "saving" overlay, since the user experience is a weird now. That would let us remove that old code.

Just as an FYI, I believe that experience was explicitly requested by @kfogel. Happy to alter it as it does make things slightly easier from a maintainence standpoint but just wanted to raise that.

frankduncan commented 3 years ago

@Nolski

Just as an FYI, I believe that experience was explicitly requested by @kfogel. Happy to alter it as it does make things slightly easier from a maintainence standpoint but just wanted to raise that.

Ah! Ok. I'm sure we'll have UI refinement meetings with him and Jeff over the next week as they actually use it. We can just put all the changes into another branch then.

frankduncan commented 3 years ago

This looks great! Unfortunately @Nolski is out of town, so he doesn't get to cut the ribbon. Sorry!