The 2026 Drupal Business Survey is open. Your response will help shape the future of the Drupal business ecosystem.I assume we could probably try improving the documentation of the module, since it has changed so much...
I mean, at least we should be moving the Drupal 6 snippets elsewhere...
Especially with Drupal 8 upon us, we should definitely be updating the documentation.
On top of that we have to deal with compatibility with popular themes such as Bootstrap (see #2125947: Bootstrap Users: note that NO block.tpl edits are required), Zen (see #2124659: No PHP snippet required with Zen theme 7.x-5.4) or Omega (see #2453577: Does not work with OMEGA framework (and others)).
Ideally, we could also try to make a more prominent statement about why users like using Block Class, as an attempt to answer #1964944: What are the technical merits of Block Class?.
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.
- Introduction: one liner to let users know what this module does (200 chars max).
- Features: what the module can do.
- Implementation: how the module does what it does.
- Troubleshooting (Known Theme issues): this is a key section where we might be able to squeeze all outstanding theme related issues, bootstrap, omega, zen and all other ones.
- Important! Installation and usage paragraph: how the module should be installed and configured.
- Review recommendations at: Project page template, Module documentation guidelines, Tips for a great project page, Best practices for creating and maintaining projects and README Template.
- Similar projects: other modules that do more or less the same things as this one.
- Many other sections: see the sections suggested by the Project page template, README Template and Tips for a great project page documents, for example, Troubleshooting, Known issues, Future developments, etc...
2 - Screenshots:
Consider adding screenshots that could demonstrate module's functions:
- Backend settings of a block's configuration CSS classes highlighted and annotated.
- Front end display of the classes in a browser inspector.
Feel free to let me know if you would have any comments, feedback, questions, issues, objections, suggestions, additions or concerns on this task, I would surely be glad to provide more information or explain in more details.
Thanks in advance to everyone for your testing, reviews, feedback and comments on this issue.
Cheers!
Issue fork block_class-2702177
Show commands
Start within a Git clone of the project using the version control instructions.
Or, if you do not have SSH keys set up on git.drupalcode.org:
changes
Comments
Comment #2
dydave commentedBringing this one back to the top of the pile, since module's project page and documentation in general would definitely need some work, refresh and updates to match with newer versions features.
For a more recent inventory of the changes needed, see: #3367869: Update Project description, clarify difference between version 3 and 4
Comment #3
dydave commentedA lot of work has already been done on module's project page, mostly while working on related documentation task:
#3475108: Update summary on project page for compatibility with Project Browser
Remaining tasks
Fix screenshot images:
With the documentation stabilized
==> Export in markdown meaningful pieces to the README files (both branches 3.x and 4.x).
Comment #8
dydave commentedQuick follow-up on this issue:
Fix screenshot images: Let's stick with the screenshots that we currently have. 👌
We can always create more specific issues later to add more screenshots to the documentation guide.
4.x: Created merge request MR !71 above at #4 and merged the changes at #6.
3.x: Created merge request MR !72 above at #5 and merged the changes at #7.
The project page seems to be displaying fine in Gitlab and is very similar to the new project page:
https://git.drupalcode.org/project/block_class
3.0.x: https://git.drupalcode.org/project/block_class/-/blob/3.0.x/README.md
4.0.x: https://git.drupalcode.org/project/block_class/-/blob/4.0.x/README.md
Same sections, screenshots, TOC, links, etc...
Kept the specific documentation for the 4.0.x branch, with the "Configuration" and "Bulk operations" sections.
We can always make more improvements to the module documentation in the future, as the module gets updated.
Marking issue as Fixed, for now.
Feel free to let us know if you would have any questions or concerns on any aspects of the latest code changes or the module in general, we would surely be glad to hear your feedback.
Thanks in advance! 😊
Comment #10
ressaBoth README's look really great now, and cover all important aspects of the Block Class module, thanks @dydave!