Converge to one coding style for datatypes #135

New issue

Closed

opened 2018-11-26 12:43:37 +00:00 by giplt · 4 comments

giplt commented

2018-11-26 12:43:37 +00:00

(Migrated from github.com)

Various datatypes (web page, article, festival) now have different coding styles. We need to compare these and make a choice for some preferred way of implementing a new module.

Things to keep in mind:

balance between flexibility and clarity in structures for data flow and processing commands
comprehensibility of code at first reading to novice coders
decide on mandatory methods:
- a default pageview
- a digest hook
- notifications
- code for automated testing
- index view
- a search hook

Various datatypes (web page, article, festival) now have different coding styles. We need to compare these and make a choice for some preferred way of implementing a new module. Things to keep in mind: - balance between flexibility and clarity in structures for data flow and processing commands - comprehensibility of code at first reading to novice coders - decide on mandatory methods: - a default pageview - a digest hook - notifications - code for automated testing - index view - a search hook

laurensmartina commented

2018-11-26 20:04:01 +00:00

(Migrated from github.com)

https://github.com/PlanBCode/hypha/blob/newtext/system/datatypes/text.php is a suggestion for a new structure

matthijskooijman commented

2019-10-31 21:06:42 +00:00

(Migrated from github.com)

This refactor is tracked in parts:

For textpage, this is already merged. Further improvements in #272.
For article, this is in #258
For mailinglist, Laurens is working on this. PR in #273.
For festival, Matthijs is working on this

After all datatypes are completed, some additional refactoring can be done to make sure that instead of one global <form> tag, there will be one for each form separately.

This refactor is tracked in parts: - For textpage, this is already merged. Further improvements in #272. - For article, this is in #258 - For mailinglist, Laurens is working on this. PR in #273. - For festival, Matthijs is working on this After all datatypes are completed, some additional refactoring can be done to make sure that instead of one global `<form>` tag, there will be one for each form separately.

matthijskooijman commented

2019-10-31 22:20:40 +00:00

(Migrated from github.com)

After this is complete, I would also like to see #264 done and maybe #274.

matthijskooijman commented

2020-08-19 10:54:17 +00:00

(Migrated from github.com)

Text, mailinglist and article have now been converted. Festival is in progress at #337. The settings special datatype should probably also be converted to allow #264 to be done.

No milestone

No project

No assignees

1 participant

Notifications

Due date

The due date is invalid or out of range. Please use the format "yyyy-mm-dd".

No due date set.

Dependencies

No dependencies set.

Reference

harmen/hypha#135

No description provided.

Rows
Columns