We could probably try improving the documentation of the module, since it has changed a bit over time.

Especially with newer versions, D8 and D9, we could provide more specific information about the setup and a bit more meaningful examples of module's syntax.

Also, we would need to better document and take into account the recent change from:
#3056108: Don't strip tags when parsing title from an h1/h2/h3/etc

Below are some ideas for some areas of improvements around the documentation of the module:
See also the Block Attributes module's project page

Project page, could be a little bit more detailed:

1 - Project page description:
We could certainly add more information about the module's configurations.

 
2 - Screenshots:
Consider adding screenshots that could demonstrate module's features:

  • Back-end filter configuration form.
  • Rich text editor with examples of collapse text tags.
  • Front-end full node view with examples of collapsible sections.

 

README.md and help:

The README.md file would simply be an adaptation of the updated project page description. If necessary add more information about module's configuration interfaces, installation and testing.

Feel free to let us know if you would have any comments, suggestions, feedbacks or questions on any of the items mentioned in this issue, we would surely be glad to answer and provide more information.

Any feedback, testing, comments or reported issues would be highly appreciated.

Thanks to all, in advance.
Cheers!

Comments

DYdave created an issue. See original summary.

  • DYdave committed c6cedf9 on 2.0.x 
    Issue #3246284 by DYdave: Improved project page, README.md and Help...
  • DYdave committed c46a79d on 8.x-1.x
    Issue #3246284 by DYdave: Improved project page, README.md and Help...
dydave’s picture

dydave commented
Status: Active » Fixed

Pretty much everything from the ticket summary was updated on the project page:

Points expanded from the existing documentation:

  • Revamped Usage paragraph to provide more information on the use of the title, class and collapsed attributes.
  • Added changes from ticket #3056108: Don't strip tags when parsing title from an h1/h2/h3/etc for the title attribute to support HTML tags in header.
  • Added section Known issues grouping paragraphs about conflicts with the HTML corrector, the string [collapse and backwards compatibility (obsolete) issues.
  • Theming section is unchanged for 8.x-1.x (D8) and was adapted for 2.0.x (D9) to provide more information about new template files.

 
New sections added:

  • Installation and configuration, with more information on how to enable the filter in site's backend (with screenshot).
  • Basic Examples to demonstrate the use of the different attributes.
  • Similar modules with the results of a basic search in the D8 filters/editors contrib modules.
  • Support and maintenance, standard paragraph with link to issue queue.

 
Screenshots added:

 
 
The changes to the README.md have been committed against the 8.x-1.x and 2.0.x branches.

With this initial round of documentation in place, all the work to be carried in this ticket should have been completed at this point, thus marking issue as Fixed for now.
We should be able to keep building on top of what we have now, as more changes and updates are made to the module.

Feel free to let us know if you have any questions on this ticket or any of the recent changes to the module, we would surely be glad to hear your feedback and comments.
Thanks!

Status: Fixed » Closed (fixed)

Automatically closed - issue fixed for 2 weeks with no activity.