You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
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:
Automatically process file names into a human readable format
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.
The text was updated successfully, but these errors were encountered:
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:
(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:
data_import
becomesdata import
dataImport
becomesdata import
performPCAonCases
becomesperform 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.data import
becomesData import
data import
becomesData Import
.Most users probably won't mind this happening automatically. An option to turn this off could be added as well.
The text was updated successfully, but these errors were encountered: