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

README: Add description of assumed place holder format #16

Closed
DonMischo opened this issue Oct 11, 2021 · 8 comments
Closed

README: Add description of assumed place holder format #16

DonMischo opened this issue Oct 11, 2021 · 8 comments
Assignees
Labels
documentation Improvements or additions to documentation

Comments

@DonMischo
Copy link
Collaborator

CSV:

Feldtrenner: Komma ,
Zeichenkettentrenner: Anführungszeichen "
UTF8

Beispiel: "Mathematik","Beschreibung",3,,,,

place holder:
Hashtag + Bezeichnung in Caps
Beispiel: #MATHEMATIK

@ArchibaldBienetre
Copy link
Collaborator

Could you paste the whole header of an example file, and a snippet of the tex file with the placeholders? 🙈

I'm not sure I'm getting it yet 😅

@ArchibaldBienetre
Copy link
Collaborator

This relates to #6

@ArchibaldBienetre
Copy link
Collaborator

Ok, one thing I saw in our knowledge share:

  • booleans are "x" or empty for true resp. false
  • the subject name is part of the header line, not in the CSV's content

@ArchibaldBienetre ArchibaldBienetre mentioned this issue Oct 16, 2021
5 tasks
@DonMischo
Copy link
Collaborator Author

CSV:

Feldtrenner: Komma , Zeichenkettentrenner: Anführungszeichen " UTF8

Beispiel: "Mathematik","Beschreibung",3,,,,

place holder: Hashtag + Bezeichnung in Caps Beispiel: #MATHEMATIK

NACHNAME,#VORNAME,#BDAY,#DEUTSCH,#MATHEMATIK,#ENGLISCH

@ArchibaldBienetre
Copy link
Collaborator

Now that I saw it once, I see that your definition was actually complete 😅

Thank you.

@ArchibaldBienetre ArchibaldBienetre added the documentation Improvements or additions to documentation label Dec 17, 2021
@ArchibaldBienetre
Copy link
Collaborator

CSV format was finalized here:
#27

Placeholder format may be subject to definition in #6 latest - or here

@ArchibaldBienetre
Copy link
Collaborator

ArchibaldBienetre commented Dec 21, 2021

After we now have the proper CSV format and it seems to work out quite well for various edge cases, I suggest we revisit the placeholders.

This is what our CSV header may look like - there are multiple columns for one subject, one for each (sub)competency.

E.g.

  • Competency 1
    • Subject: "Deutsch"
    • Competency: "Texte rezipieren"
    • Sub-competency: "Lese- und Hörverstehen"
    • (Description - ignored here)
  • Competency 2
    • Subject: "Deutsch"
    • Competency: "Texte produzieren"
    • Sub-competency: "Sprechen"
    • (Description - ignored here)

So, the subject alone is not enough, it should rather be a composed key that can be calculated from subject, competency and sub-competency.

E.g., in this case:

  • Competency 1: #DEUTSCH__TEXTE_REZIPIEREN__LESE_UND_HOERVERSTEHEN
  • Competency 2: #DEUTSCH__TEXTE_PRODUZIEREN__SPRECHEN

Calculation:

  • replace all umlauts and ß with the common German transliterations (ä -> ae, ö -> oe, ü -> ue, ß -> ss)
  • replace all "special characters" and spaces with "_"
  • merge parts using "__" as delimiter
  • capitalize

However, all this still leaves a lot of work to the tex template designer.

I wonder if this is intentional, or if we should aim for an iteration approach in the future.
This may add additional constraints, maybe that's not something for the MVP.

@ArchibaldBienetre ArchibaldBienetre changed the title Input.csv und place holder README: Add description of assumed place holder format Feb 18, 2022
@ArchibaldBienetre ArchibaldBienetre self-assigned this Feb 18, 2022
@ArchibaldBienetre
Copy link
Collaborator

ℹ️ For version 1.0.0 we are now working with fixed placeholders.

We should documen these alongside the CSV documentation from #66

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

2 participants