Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Meeting notes should be stored in the document content instead of a textarea property #72

Closed
lucaa opened this issue Sep 2, 2020 · 0 comments

Comments

@lucaa
Copy link

lucaa commented Sep 2, 2020

Currently, the meeting application has 2 free rich text properties:

  • the meeting "plan" (agenda, ordre du jour in french), supposed to be filled in before the meeting starts by the meeting organisers
  • the meeting notes, supposed to be filled in during the meeting by the note taker for the meeting.

Currently, both these properties are large text properties of the meeting class.

The modern practices for XWiki applications allow and encourage reusing document metadata (title, content) in an application (see the properties panel in AWM which allows to add these 2 as props of an application).

For the meeting application, from the 2 properties, the meeting notes should be stored in the content of the document.

Advantages:

  • alignment with modern practices
  • reuse of an existing column in the database that would be empty anyway, the document content
  • easier migration to / from a simple document to a meeting notes document (for example, transforming an existing regular page in a meeting note would be only about adding an object, the notes would be picked up automatically from the document content)
  • benefiting from some standard XWiki features that are designed to work for document content but not for textarea properties:
    • backlinks management, for versions of XWiki before 11.2 ( https://jira.xwiki.org/browse/XWIKI-981 )
    • realtime editing, if any (using the realtime extension), which , if it works it has more chances to work on the document content than on the object properties
    • search indexation and scoring of meeting notes documents: having the main content of the document in the document content would cause the meeting page to show up high in the search results list when a user is looking for an information that is in the actual meeting notes
    • annotations (?), etc. any feature that would consider that the main "content" is in the document content.
@acotiuga acotiuga self-assigned this Nov 27, 2020
acotiuga added a commit that referenced this issue Nov 27, 2020
…extarea property #72

* this improvement demands changes in the class, sheet and template
* also provide a migration script that will transfer the meeting notes from the "notes" property of the Meeting class to the document content
@acotiuga acotiuga added this to the 1.11 milestone Nov 27, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

2 participants