New naming conventions for *.md file #35

Closed
opened 2026-04-20 16:10:40 +00:00 by SaschaFuksa · 0 comments
Owner

When sending to a repository, we rename our structured.md.
Currently we only add the h1, h2 or h3 as file name.
This leads to problem, if the h1 -> book title is named in every audio session. If a md file with same name in repo already exists, it will be overriden.
To solve this, please add a additional information to the file name: The hhmmss (hour minutes seconds).
Currently our folder name is 20260418_162032
The yyyymmdd is already used for the repo folder name.
Now also use the hhmmss for the file name. For example:
20260418_162032
-> structured.md
content: "# Praxiseinstieg Machine Learning

Kapitel 3: Klassifikation

Absatz: Klassifikatoren mit mehreren Kategorien

  • Binäre Klassifikatoren: Unterscheiden zwischen genau zwei Kategorien.
  • Multinomiale Klassifikatoren: Können zwischen mehr als zwei Kategorien unterscheiden.
  • Beispiele für Algorithmen in Scikit-Learn:
    • Logistic Regression
    • Random Forest Classifier
    • Gaussian Naive Bayes (Gaussian NB)"

Shall be lead to following MD file name:
162032-Praxiseinstieg Machine Learning-Kapitel 3 Klassifikation-Absatz Klassifikatoren mit mehreren Kategorien

So the name should be:
hhmmss-h1-h2-h3

But be careful!
Only use h1, if h1 is at start of document.
Only use h2, if h2 is start of document OR h2 is directly after h1 at start of document
Only use h3, if h3 is start of document OR h3 is directly after h2 and h2 is directly after h1 at start of document.

This rule is important!

So the hhmm22 shall always be at start of the file name.

When sending to a repository, we rename our structured.md. Currently we only add the h1, h2 or h3 as file name. This leads to problem, if the h1 -> book title is named in every audio session. If a md file with same name in repo already exists, it will be overriden. To solve this, please add a additional information to the file name: The hhmmss (hour minutes seconds). Currently our folder name is 20260418_162032 The yyyymmdd is already used for the repo folder name. Now also use the hhmmss for the file name. For example: 20260418_162032 -> structured.md content: "# Praxiseinstieg Machine Learning ## Kapitel 3: Klassifikation ### Absatz: Klassifikatoren mit mehreren Kategorien - **Binäre Klassifikatoren**: Unterscheiden zwischen genau zwei Kategorien. - **Multinomiale Klassifikatoren**: Können zwischen mehr als zwei Kategorien unterscheiden. - **Beispiele für Algorithmen in Scikit-Learn**: - Logistic Regression - Random Forest Classifier - Gaussian Naive Bayes (Gaussian NB)" Shall be lead to following MD file name: 162032-Praxiseinstieg Machine Learning-Kapitel 3 Klassifikation-Absatz Klassifikatoren mit mehreren Kategorien So the name should be: hhmmss-h1-h2-h3 But be careful! Only use h1, if h1 is at start of document. Only use h2, if h2 is start of document OR h2 is directly after h1 at start of document Only use h3, if h3 is start of document OR h3 is directly after h2 and h2 is directly after h1 at start of document. This rule is important! So the hhmm22 shall always be at start of the file name.
Sign in to join this conversation.
No labels
No milestone
No project
No assignees
1 participant
Notifications
Due date
The due date is invalid or out of range. Please use the format "yyyy-mm-dd".

No due date set.

Dependencies

No dependencies set.

Reference
Tasch/whisper-transcribe#35
No description provided.