Transfer blog tags + icons to yaml for a CMP #91
Comments
dominikgeissler
added
enhancement
|
what do you think about this @janosh ? |
|
@dominikgeissler Sure sounds good. What help do you need? I think @kleinicke might know how to do this? Also cmp = content management program? |
|
@janosh yeah exactly (program =~ plattform). |
|
we often use the same icons in different places (i.e. calendar / graduation cap). do you think we should define certain icons globally (e.g. |
|
I'm fine with changing stuff on the fly. It's usually hard to anticipate future needs so flexibility is king. 😄 |
|
i've extracted all icons1 we're currently using (by page and an informal description chosen by me): basePage:
updated: "ic:update"
chapterList:
place: "ic:place"
construction: "ic:round-construction"
footer:
imprint: "octicon:law"
dataprivacy: "ic:round-privacy-tip"
donate: "ic:round-euro"
statues: "ion:document-text"
openSource: "ri:open-source-fill"
cookie: "bxs:cookie"
nav:
hamburger: "heroicons-solid:menu"
aboutus: "ri:plant-fill"
chapters: "ic:place"
participate: "ion:people-circle"
blog: "fa-solid:rss-square"
contact: "ic:round-alternate-email"
internal: "fa-solid:hands-helping"
signup: "ic:round-assignment-ind"
expand: "bi:chevron-expand"
placeSelect:
delete: "ic:delete"
postPreview:
link: "bx:link"
email: "ic:email"
graduationcap: "fa-solid:graduation-cap"
calendar: "octicon:calendar"
tags: "fa-solid:tags"
social:
facebook: "fa-brands:facebook"
twitter: "fa-brands:twitter"
instagram: "fa-brands:instagram"
youtube: "fa-brands:youtube"
linkedin: "fa-brands:linkedin"
taglist:
tag: "fa-solid:tags"
close: "ic:round-close"
expand: "bi:chevron-expand"
blogtag:
Alle: "ic:select-all"
Spenden: "ic:round-euro"
Werbung: "ic:public"
Standortleiter: "fa-solid:graduation-cap"
Erfahrungsberichte: "ic:rate-review"
Nachhilfelehrer: "fa-solid:chalkboard-teacher"
Interview: "ic:question-answer"
'Soziale Partner': "fa-solid:handshake"
Events: "ic:event-available"
Freizeit: "ic:beach-access"
IT: "bx:git-branch"
Bundesvorstand: "ion:stats-chart"
Stipendium: "fa-solid:donate"
Mentoring: "fa-solid:chalkboard-teacher"
Auszeichnung: "fa-solid:award"
Sonstiges: "fa6-solid:earth-europe"
Standorte: "fa6-solid:map-location-dot"
themeswitcher:
light: "ic:round-wb-sunny"
dark: "octicon:moon-16"
system: "bi:laptop"
routes:
child: "fa-solid:child"
graduate: "fa-solid:user-graduate"
place: "ic:place"
scholarship: "fa-solid:user-graduate"
award:
calendar: "octicon:calendar"
prize: "fa-solid:award"
slug:
person: "bi:person-circle"
bio: "ic:round-history-edu"
study: "fa-solid:graduation-cap"
calendar: "octicon:calendar"
faq:
'Rund ums Engagement': "fa-solid:hands-helping"
Nachhilfe: "fa-solid:chalkboard-teacher"
Vermittlung: "ic:round-support-agent"
Alle: "ic:select-all"
Rahmenbedingungen: "ic:filter-frames"
Vereinsaustritt: "ic:exit-to-app"
Sonstiges: "ic:round-miscellaneous-services"
Datenschutz: "ic:round-privacy-tip"
'Tipps für Standorte': "ic:round-storefront"
Versicherung: "map:insurance-agency"
Mitgliederversammlung: "ic:round-group"
Führungszeugnis: "ic:round-assignment-ind"
tags: "fa-solid:tags"
learningmaterial:
Alle: "ic:select-all"
Mathe: "ic:functions"
Wissenschaft: "ic:round-science"
'Lernen mit Karteikarten': "bi:card-text"
'Viele Fächer': "ic:group-work"
'Deutsche Sprache': "ic:language"
Englisch: "fa-brands:erlang"
Deutschunterricht: "simple-icons:disqus"
Physik: "simple-icons:atom"
press:
source: "ion:newspaper"
calendar: "octicon:calendar"
chapter: "ic:place"
signup_pupil:
header: "ri:plant-fill"
signup_student:
header: "ri:plant-fill"
chapter:
joinstudent: "fa-solid:graduation-cap"
studentinfo: "bi:info-circle-fill"
joinpupil: "fa-solid:child"
pupilinfo: "bi:info-circle-fill"
email: "ic:email"the number of occurrences is given here2:
i'ld add some icons (e.g. the calendar icon or commonly used ones) to a kind of global set (to maintain a certain consistency) whereas more specific icons (esp. the icon tags ^^) will be encoded similar to the yaml i provided. should i put these in the Footnotes
|
|
Any action required on my part? |
|
not atm ^^ |
|
My idea would be to either
Since the implementation would be pretty straight forward this is just a design choice. I'm not sure which option is better, however I think a thematic grouping could be an advantage even though this leads to more configuration overhead. Nonetheless I would propose the following structure icons:
# globally used icons e.g. mail
global:
# e.g.
# mail: <some-icon>
pages:
# convention
# slug:
# textual-description: <icon_name>
# could also be translated to be more general
# e.g.
# standorte:
# place: <some-icon>
blog:
# some more 'specific' icons e.g. for blog posts
# e.g.
# IT: <some-icon>
|
|
I think I've found a suitable solution: # Rule of thumb: Define own key-values with pointers rather than using the global icons explicitly
# However, use the globally defined icons when they suit the context s.t. a global change changes appropriate icons
# Own key-value pairs with pointers bear the advantage, that the values can be changed without adding new pairs
# This guarantees a similar flexibility as currently, but also has the advantages of globally defined icons
icons:
# icons that are reused often without needing a certain context
global:
graduationcap: &GRADUATION_CAP "fa-solid:graduation-cap"
# ...
blogtags:
# use references to denote dependencies as well as keeping individual flexibility
chaptermanager: *GRADUATION_CAP
# ...
pages:
# Here less often used icons can be placed (or some that require a certain context / independency)
somepage:
oddly-specific-icon: whatever
# ... |
…microcopy calls, added icons to smallTexts
|
paused till I'm sure how to test it without destroying everything |
Maybe we can add the current representation of icons <-> tags in a
.yaml-file in order to integrate it into a cmp. Would mean less coding / github interaction and a better experience for writers.The text was updated successfully, but these errors were encountered: