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

Default CSS: Add PMLC Version Info #12

Closed
tajmone opened this issue Mar 21, 2021 · 5 comments
Closed

Default CSS: Add PMLC Version Info #12

tajmone opened this issue Mar 21, 2021 · 5 comments
Labels
enhancement New feature or request

Comments

@tajmone
Copy link
Contributor

tajmone commented Mar 21, 2021

Pleas inject into default CSS styles the version number of the pmlc tool that generated them, i.e. within the stylesheets commented header, at the beginning.

This might be a safer practice, in case end users are manually modifying copies of these CSS files for substituting the default CSS generated by pmlc. Having pmlc version info might warn end users of possible changes in class names or the HTML template structure.

@pml-lang
Copy link
Owner

Good point!
It's done.
Example: PML_CSS_files.zip

@tajmone
Copy link
Contributor Author

tajmone commented Mar 22, 2021

Great! Thanks.

I wanted to experiment a bit with SASS templates, a sort of "Stylesheet Factory" that could auto-generate PML CSS via different color schemes, etc — mostly to start and get a feel of the underlying HTML template structure, and how it can be styled via CSS.

Definitely, CSS and HTML templates customization is a feature most end users love in any documentation generator, especially HTML templating, which would allow to add custom nav bars and use PML for websites or HTML books, not just single-page docs.

@pml-lang
Copy link
Owner

auto-generate PML CSS via different color schemes

Excellent idea. Color is always a matter of personal preferences (and branding sometimes). We should make it easy for users to chose their preferred colors, styling, and layouts.

CSS and HTML templates customization is a feature most end users love in any documentation generator

True 100%.
Too much choice is not always good, but easy and flexible CSS and HTML customization is necessary.
Reminds me excellent advice I'm fond of:
"It should be easy to do simple things; possible to do complex things; and impossible, or at least difficult, to do wrong things."
Joshua Bloch: Bumper-Sticker API Design

use PML for websites or HTML books, not just single-page docs

Yes and yes.

@tajmone
Copy link
Contributor Author

tajmone commented Mar 24, 2021

Color is always a matter of personal preferences (and branding sometimes).

But also a matter of web-accessibility, e.g. for the color blind (see:Fossy-Cats/Git-Buch_EN#15).

Any default HTML templates and stylesheets should meet as many triple As (AAA) as possible for web accessibility standards, IMO, and then end users are free to use whatever they want. Unfortunately, in the software industry, in general, we're not witnessing enough efforts in terms of accessibility in UI/GUI designs. Striving in a FOSS project to stick to those guidelines as much as possible, and being able to proudly publicize it in its website, would be a great way to promote awareness about accessibility issues. Furthermore, providing a web-accessible-ready product would be a strong incentive to its use.

https://www.w3.org/WAI/fundamentals/accessibility-intro/

@pml-lang
Copy link
Owner

Important point to consider. Well said.

Thanks for the link. Will read it thoughtfully, because I'm a noob when it comes to web accessibility.

@pml-lang pml-lang added the enhancement New feature or request label May 3, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

2 participants