| Recommend this page to a friend! |
| Packages of Matthew Asham | Binkterm PHP | docs/proposals/FileAreaComments.md | Download |
|
|||||||||||||||||||||
> Draft ? This proposal was generated by AI and may not have been reviewed for accuracy. File Area Echomail CommentsOverviewA file area can be linked to an echomail area to enable threaded comments on individual files. This is a community edition feature available to all installations. Because the backing store is real echomail, FTN users on other systems participate transparently ? their replies appear as comments in the file area view with no special configuration required on either end. How It Works
Comment Display ? Matching Messages to FilesThe file detail page queries the linked echomail area using a two-tier strategy:
BinktermPHP-to-BinktermPHP comment linking is exact via the kludge. Threads from other FTN software still display correctly as long as they follow the subject convention. Network BehaviourThe Nodes running other BBS software ignore the kludge and see a normal echomail thread. Their replies propagate back through the network and appear as comments on BinktermPHP nodes via the subject fallback. ConfigurationConfigured per file area. The sysop selects a linked echomail area from the file area admin page. All files in that file area share the same linked echomail area for comments. A file area with no linked echomail area simply has no comment functionality ? the comment UI is not shown. SchemaNo dedicated comment mapping table is required. The file area ? echomail area linkage is stored in the file areas configuration (a new nullable Message-to-file association is resolved at query time via the kludge and subject matching described above. The Required migrations
UIFile listingA comment count badge (speech bubble icon + count) is shown on file rows where the linked echomail area has at least one matching message. Files with no comments show no badge, keeping the listing clean. Clicking the badge opens the file info modal scrolled to the comments section. File info modalThe canonical place to read and post comments. A mini echomail thread is displayed below the file metadata. Thread display: - Shows the 5 most recent comments by default; a "Show all N comments" control expands the full thread - No per-branch collapse ? once expanded, the full thread is visible - Threaded display with indentation, capped at 3 levels deep; replies beyond level 3 render flat at level 3 - Per message: author name, date, and plain text body only ? no kludge lines, no tearlines, no ANSI rendering - Author name follows the name policy of the linked echomail area (real name or username), consistent with how the area handles regular echomail Reply form: - Hidden behind a "Leave a comment" button; expands inline when clicked - Body textarea only ? subject is inherited from the thread root, to-address is implicit - Visible to logged-in users only - Guests see a blurred mock comment thread with a "Login to read" overlay instead of the real comments and reply form File previewComments are not shown in the file preview ? users are focused on the file content there and the comment UI would be out of place. File area adminTwo options for linking a comments area: The UI uses a combobox-style control ? the sysop can either select an existing echomail area from the dropdown or type a new tag to create one:
The pre-filled suggested tag when the sysop opens the control:
- Echomail area viewMessages posted via file comments appear as normal echomail and are readable in the echomail area view on any node. PermissionsPosting comments requires the user to be logged in. Posting permissions otherwise follow the linked echomail area ? if the area is sysop-only, only sysops can comment. Guests see a blurred mock comment section with a "Login to read" overlay in place of the real thread and reply form. ModerationComment moderation is handled through the echomail area itself ? sysops delete unwanted comments via the normal echomail admin interface. There is no dedicated moderation UI in the file area view at this time; this may be revisited in a future iteration. SHA-256 Hashing
Comment Count CachingThe comment count badge in the file listing must not query the echomail table live per file row. Counts are cached ? either as a denormalised column on the files table or in a small summary table ? and updated when:
Cache invalidation strategy and storage details to be determined at implementation time. Scope and Limitations
|