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

Improve readability of website menu/item names #1

Open
matthewcarlucci opened this issue Sep 25, 2020 · 1 comment
Open

Improve readability of website menu/item names #1

matthewcarlucci opened this issue Sep 25, 2020 · 1 comment
Labels
enhancement New feature or request

Comments

@matthewcarlucci
Copy link
Owner

Raw file names for navigation menus may not be the most friendly to readers and makes scikick projects look a little less refined than they could. There are two main approaches I see to improving this:

  1. Automatically process file names into a human readable format
  2. Allow for manual mapping of file name to menu/item name

(2) requires too much effort for the goals of scikick as a simple and standardized tool, but it will be possible when functionality for customization of the website is added (possibly through user defined _site.yml files). So I think it is best to focus on (1).

Conversion of file names to human readable will require some rules. The following rules are being considered:

  • For snake case, replace all "_" with a space.
    • data_import becomes data import
  • For camel case (I think this one has more potential for issues), a single capital denotes a new word. Add a space before it.
    • dataImport becomes data import
  • For a sequence of capitalized letters, place a space in front of the first and after the last character.
    • performPCAonCases becomes perform PCA on cases. A slight issue here would be if there are back-to-back acronyms. I see no way to resolve this other than forced use of snake case.
  • Menu items become 'sentence case', so just the first word's first letter is capitalized.
    • data import becomes Data import
  • Menus are 'title case'.
    • data import becomes Data Import.

Most users probably won't mind this happening automatically. An option to turn this off could be added as well.

@matthewcarlucci matthewcarlucci added the enhancement New feature or request label Sep 25, 2020
@matthewcarlucci
Copy link
Owner Author

Some of these features were added as part of commit c86afb7. Still missing is support for camel-case transformation.

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

1 participant