SergelsOrg / csv2tex

Tool to replace placeholders in tex-files
GNU General Public License v3.0
5 stars 0 forks source link

README: Add description of assumed place holder format #16

Closed DonMischo closed 2 years ago

DonMischo commented 3 years ago

CSV:

Feldtrenner: Komma , Zeichenkettentrenner: Anführungszeichen " UTF8

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

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

ArchibaldBienetre commented 3 years ago

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

I'm not sure I'm getting it yet :sweat_smile:

ArchibaldBienetre commented 3 years ago

This relates to https://github.com/DonMischo/csv2tex/issues/6

ArchibaldBienetre commented 3 years ago

Ok, one thing I saw in our knowledge share:

DonMischo commented 3 years ago

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 commented 3 years ago

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

Thank you.

ArchibaldBienetre commented 2 years ago

CSV format was finalized here: https://github.com/SergelsOrg/csv2tex/issues/27

Placeholder format may be subject to definition in https://github.com/SergelsOrg/csv2tex/issues/6 latest - or here

ArchibaldBienetre commented 2 years ago

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.

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:

Calculation:


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 commented 2 years ago

:information_source: For version 1.0.0 we are now working with fixed placeholders.

We should documen these alongside the CSV documentation from https://github.com/SergelsOrg/csv2tex/issues/66