expo/troggle
2
0
Fork 1
mirror of https://expo.survex.com/repositories/troggle/.git synced 2025-02-17 04:30:13 +00:00
Code Issues 18 Projects 3 Activity

WYSIWYG Editor for Troggle Pages #9

New Issue
Open
opened 2023-08-02 16:14:49 +01:00 by xle · 6 comments
xle commented 2023-08-02 16:14:49 +01:00
Owner
Copy Link

The current HTML editor for troggle pages is error-prone for the non-nerdy.

I'm sure it has its supporters and I don't think it need be depreciated, but I'm equally sure that there are some good WYSIWYG editor plugins about that wouldn't be too difficult to implement.

One that allows you to directly edit the HTML if you so choose would be ideal.

The current HTML editor for troggle pages is error-prone for the non-nerdy. I'm sure it has its supporters and I don't think it need be depreciated, but I'm equally sure that there are some good WYSIWYG editor plugins about that wouldn't be too difficult to implement. One that allows you to directly edit the HTML if you so choose would be ideal.
xle added this to the Expo 2024 milestone 2023-08-02 16:14:49 +01:00
xle added the
Enhancement
High Priority
Minor Change
 labels 2023-08-02 16:14:49 +01:00
xle added this to the Front-end Enhancements project 2023-08-02 16:14:49 +01:00
PhilipSargent commented 2023-08-02 18:40:52 +01:00
Member
Copy Link

We used to use TinyMCE, which worked very well, but failed as part of the Great Package Update when we moved from python2 to python3 and from Django 1.07 to 3.2 and everything broke sideways several times over several months and much hair was lost by several people - some of whom we have never seen since.

The latest version does inline editing too. It's just waiting for someone with time on their hands to do it.

But note that integrating JS libraries needs care as these are served differently on the server than on dev setups, and on the server we only use Debian Packaged Software (see Wookey for full details).
See https://expo.survex.com/handbook/troggle/serverconfig.html#js

We used to use TinyMCE, which worked very well, but failed as part of the Great Package Update when we moved from python2 to python3 and from Django 1.07 to 3.2 and everything broke sideways several times over several months and much hair was lost by several people - some of whom we have never seen since. The latest version does inline editing too. It's just waiting for someone with time on their hands to do it. But note that integrating JS libraries needs care as these are served differently on the server than on dev setups, and on the server we only use Debian Packaged Software (see Wookey for full details). See https://expo.survex.com/handbook/troggle/serverconfig.html#js
xle commented 2023-08-02 20:32:21 +01:00
Author
Owner
Copy Link

Thanks @PhilipSargent, that's really useful to know.

I wonder if there is a third party TinyMCE django plugin/app that we might be able to bring in to take some of that maintenance work off our hands?

Thanks @PhilipSargent, that's really useful to know. I wonder if there is a third party TinyMCE django plugin/app that we might be able to bring in to take some of that maintenance work off our hands?
xle commented 2023-08-02 20:51:48 +01:00
Author
Owner
Copy Link

https://www.tiny.cloud/docs/integrations/django/ seems to have a simple enough implementation - the JS library can be used straight from their CDN if hosting it ourselves is too much to handle easily.

https://www.tiny.cloud/docs/integrations/django/ seems to have a simple enough implementation - the JS library can be used straight from their CDN if hosting it ourselves is too much to handle easily.
xle commented 2023-08-02 21:15:10 +01:00
Author
Owner
Copy Link

This even implements an HTMLField object - https://django-tinymce.readthedocs.io/en/latest/usage.html#the-htmlfield-model-field-type which it suggests can be used with the django.contrib.flatpages app. Maybe this is a can of worms I don't want to open but given that https://docs.djangoproject.com/en/4.2/ref/contrib/flatpages/ exists and I can't see it called in the settings.py file, how is it that we implement our "edit this page" functionality? Surely we don't reinvent the wheel to such a degree that we have a complete re-implementation of part of the django base package? Surely?

This even implements an `HTMLField` object - https://django-tinymce.readthedocs.io/en/latest/usage.html#the-htmlfield-model-field-type which it suggests can be used with the `django.contrib.flatpages` app. Maybe this is a can of worms I don't want to open but given that https://docs.djangoproject.com/en/4.2/ref/contrib/flatpages/ exists and I can't see it called in the `settings.py` file, how is it that we implement our "edit this page" functionality? Surely we don't reinvent the wheel to such a degree that we have a complete re-implementation of part of the django base package? Surely?
PhilipSargent commented 2023-08-04 22:52:23 +01:00
Member
Copy Link

We learned the hard way to absolutely minimize the number of Django packages, and python packages, that troggle uses.
We had to take a big axe to some functionality to get it to run at all. And we don't use 'staticpages' any more, which is an absolutely standard Django package, but which blocked our upgrade process for a month or s because of package-package version incompatibilities.

CUYC got into a very nasty mess with their Django system with PayPal integration which completely blocked upgrading to later Django versions (Ask Paul Fox for details), Probably still deeply broken 3 years later.

So think VERY HARD before committing to a new Django package.
A Javascript add-on, on the other hand, is more easily discarded and replaced.

We learned the hard way to absolutely minimize the number of Django packages, and python packages, that troggle uses. We had to take a big axe to some functionality to get it to run at all. And we don't use 'staticpages' any more, which is an absolutely standard Django package, but which blocked our upgrade process for a month or s because of package-package version incompatibilities. CUYC got into a very nasty mess with their Django system with PayPal integration which completely blocked upgrading to later Django versions (Ask Paul Fox for details), Probably still deeply broken 3 years later. So think VERY HARD before committing to a new Django package. A Javascript add-on, on the other hand, is more easily discarded and replaced.
PhilipSargent commented 2023-08-07 22:03:32 +01:00
Member
Copy Link

This is what TinyMCE used to look like when editing a handbook page:
https://expo.survex.com//handbook/i/editthispage.jpg
image

This is what TinyMCE used to look like when editing a handbook page: https://expo.survex.com//handbook/i/editthispage.jpg ![image](/attachments/9a84e3c4-d5f2-4393-ada3-a5a60c67965b)
image.png
300 KiB
👍 1
Sign in to join this conversation.
No Branch/Tag Specified
Branches Tags
Labels
Clear labels
Bug
Bug - something that doesn't work as it should do
Enhancement
New feature or enhancement
High Priority
Critical issue. Fix/implement ASAP
Low Priority
Non-critical issue, nice-to-haves etc.
Major Change
Change of large scope
Minor Change
Change of small scope
No Label
Enhancement
High Priority
Minor Change
Milestone
No items
No Milestone Expo 2024
Projects
Clear projects
No project Front-end Enhancements
Assignees
Clear assignees
No Assignees
2 Participants
Notifications
Due Date
No due date set.
Dependencies

No dependencies set.

Reference: expo/troggle#9
No description provided.
Delete Branch "%!s()"

Deleting a branch is permanent. Although the deleted branch may continue to exist for a short time before it actually gets removed, it CANNOT be undone in most cases. Continue?