From deb1d0c377933717a7c6546f29fd197eff1fcc6d Mon Sep 17 00:00:00 2001 From: Philipp Stadler <hello@phstadler.com> Date: Thu, 25 Jul 2024 11:50:52 +0200 Subject: [PATCH] feat: add simple vocabulary APKG with just one card --- README.md | 30 +++------------ content/Bijection-from-CSV/.apkg-spec.yaml | 21 ----------- content/Bijection-from-CSV/content.csv | 2 - content/Bijection-from-Images/.apkg-spec.yaml | 15 -------- content/Bijection-from-Images/red.png | Bin 546 -> 0 bytes content/Facts-from-CSV/.apkg-spec.yaml | 21 ----------- content/Facts-from-CSV/content.csv | 1 - content/Vocabulary-from-Anki/.apkg-spec.yaml | 35 ------------------ content/Vocabulary-from-Anki/Chinesisch.txt | 8 ---- content/Vocabulary-from-Anki/README.md | 17 --------- .../Your-custom-vocabulary/.apkg-spec.yaml | 21 +++++++++++ content/Your-custom-vocabulary/Chinesisch.csv | 1 + package.json | 2 +- 13 files changed, 29 insertions(+), 145 deletions(-) delete mode 100644 content/Bijection-from-CSV/.apkg-spec.yaml delete mode 100644 content/Bijection-from-CSV/content.csv delete mode 100644 content/Bijection-from-Images/.apkg-spec.yaml delete mode 100644 content/Bijection-from-Images/red.png delete mode 100644 content/Facts-from-CSV/.apkg-spec.yaml delete mode 100644 content/Facts-from-CSV/content.csv delete mode 100644 content/Vocabulary-from-Anki/.apkg-spec.yaml delete mode 100644 content/Vocabulary-from-Anki/Chinesisch.txt delete mode 100644 content/Vocabulary-from-Anki/README.md create mode 100644 content/Your-custom-vocabulary/.apkg-spec.yaml create mode 100644 content/Your-custom-vocabulary/Chinesisch.csv diff --git a/README.md b/README.md index 18c9743..bb68701 100644 --- a/README.md +++ b/README.md @@ -1,30 +1,12 @@ # Brand spanking new Anki Pack -Hi, do you want to build a new Anki pack? You can start with this repository! +Hi, do you want to build your own vocabulary with Anki and want to take +advantage of a feature-rich template without writing any code? -If you want to learn, not create new content, see the user guide in -[English](https://gitlab.phaidra.org/kartenaale/getting-started-with-anki/-/blob/main/GUIDE.md) -or -[German](https://gitlab.phaidra.org/kartenaale/getting-started-with-anki/-/blob/main/ANLEITUNG.md). +Download this APKG with just one card and then add your own, right within Anki. -## First-time setup for a new project -Create a -[new project](https://gitlab.phaidra.org/projects/new?namespace_id=2286#import_project) -in the _Anki Packs_ namespace and choose _Repository by URL_ with this repo: -``` -https://gitlab.phaidra.org/kartenaale/templates/anki-pack.git -``` - -This step will also clone this README. You can change it later to remove this -section and tell your users something about your pack instead. - -Next, enable Gitlab CI for your project. With this feature, your new content -will produce Anki packages on Merge Requests and on the main branch. To enable, -open _Settings_ in the new Gitlab project and expand -_Visibility, project features, permissions_. _CI/CD_ under _Repository_ should -be _enabled_. Customize Merge Requests and other settings to your liking ( -_Pipelines must succeed_ is highly recommended). - -*Everything below this point is not starter-project-specific, you may want to keep it* +The template used in the package is much easier to use than the templates used +for the other packages, where you need to fill in more fields to get all the +functionality. ## Importing the pack to your phone or PC Open _Deployments | Releases_ on the left, then click _Browse all APKGS…_ on diff --git a/content/Bijection-from-CSV/.apkg-spec.yaml b/content/Bijection-from-CSV/.apkg-spec.yaml deleted file mode 100644 index bde3043..0000000 --- a/content/Bijection-from-CSV/.apkg-spec.yaml +++ /dev/null @@ -1,21 +0,0 @@ -content_version: 1.0.0 - -templates: -- bijective - -content: -- import_csv: - content_version: 2024-06-08 18:23:00+00:00 - note_type: Bijection - file_patterns: - - 'content.csv' - delimiter: ';' - deck_name_pattern: 'Tapir geography' - fields_mapping: - - guid - - A - - B - fields_static: {} - tags: [] - -resource_paths: [] diff --git a/content/Bijection-from-CSV/content.csv b/content/Bijection-from-CSV/content.csv deleted file mode 100644 index d68fa71..0000000 --- a/content/Bijection-from-CSV/content.csv +++ /dev/null @@ -1,2 +0,0 @@ -7856975905780;Continent: Europe, Australia, Antarctica;Species: none -5423654674576;Continent: Asia;Species: Tapirus indicus diff --git a/content/Bijection-from-Images/.apkg-spec.yaml b/content/Bijection-from-Images/.apkg-spec.yaml deleted file mode 100644 index a646def..0000000 --- a/content/Bijection-from-Images/.apkg-spec.yaml +++ /dev/null @@ -1,15 +0,0 @@ -content_version: 1.0.0 - -templates: -- bijective - -content: -- import_images: - content_version: 2024-02-22 19:00:00+00:00 - note_type: Bijection - deck_name_pattern: 'Colors' - fields_mapping: - A: 'The color {{from_basename}}' - B: '{{image}}' - -resource_paths: [] diff --git a/content/Bijection-from-Images/red.png b/content/Bijection-from-Images/red.png deleted file mode 100644 index 45963e5fca95e06822eef5da0ac0ece43c2a8c30..0000000000000000000000000000000000000000 GIT binary patch literal 0 HcmV?d00001 literal 546 zcmeAS@N?(olHy`uVBq!ia0y~yU|<Ac4kiW$h6&}t_ZS!$TQZ%U13aCb6$*;-(=u~X z85lGs)=sqbIP4(Nc7K^ycZkSag+~(>THSPYmD$SWx<VkUHB8n=?{BjjuV+{H;s;R$ zAJR9zdhlq?>gLr79RC_DtSvNmd34@aZ51<=yL0z&_5I&P-(?j{w0t)2N@MihezwF& zF|BxY(hE^Vo(1!-Z8)Qo>^CXsgKYeFjt_tJ&Tanl`k&0+tb0ig4l46f+cJgo1^n}G zu|2PSq@jIM>!anz9iHMUbx(FZ`Y8Q;(P^ghJ+o$hu_>Gqp;NZu(!n(;Sx1787=~Wf zj6YGers&?IHKAE+O8x&G@`#I%d}ei4P-SC>s)xYB1#L!J8w8ifsvmWlbxzpsU*dKB ziQbCgl07oqE1a6&{5tsmL3#e#Lr+?!i+D2J)$jXk$kkHTn0B{tU%%|~N+y>1joN$P zt~YC#>3`{Uu5KC2mt1D?>$$!+nf1yW7OFd&rG|4|65(Qf@V955COgkPCfn?|`%%v= zY8i~KtiHlqP{7e6s#$&a`Q3--_Wg~%{OUfx=GUT5ljEX+3=9mM1s;*b3=De8Ak0{? z)V_>?fq}im)7O>#1-p;{hf&gPj?D}V43Z_T5hc#~xw)x%B@E6*sfi`2DGKG8B^e6t wp1uL$jeOz^3=BM;E{-7_*OPyoKfu7i%*e<fakqB^0|Nttr>mdKI;Vst0G;ID5&!@I diff --git a/content/Facts-from-CSV/.apkg-spec.yaml b/content/Facts-from-CSV/.apkg-spec.yaml deleted file mode 100644 index f9f6972..0000000 --- a/content/Facts-from-CSV/.apkg-spec.yaml +++ /dev/null @@ -1,21 +0,0 @@ -content_version: 1.0.0 - -templates: -- facts - -content: -- import_csv: - content_version: 2024-06-08 18:23:00+00:00 - note_type: Facts - file_patterns: - - '*.csv' - delimiter: ';' - deck_name_pattern: 'Tapir facts' - fields_mapping: - - guid - - Front - - Back - fields_static: {} - tags: [] - -resource_paths: [] diff --git a/content/Facts-from-CSV/content.csv b/content/Facts-from-CSV/content.csv deleted file mode 100644 index 1767be3..0000000 --- a/content/Facts-from-CSV/content.csv +++ /dev/null @@ -1 +0,0 @@ -123412354152;How many tapir species live in the wild in Asia?;1 diff --git a/content/Vocabulary-from-Anki/.apkg-spec.yaml b/content/Vocabulary-from-Anki/.apkg-spec.yaml deleted file mode 100644 index 68f3143..0000000 --- a/content/Vocabulary-from-Anki/.apkg-spec.yaml +++ /dev/null @@ -1,35 +0,0 @@ -content_version: 1.0.0 - -templates: -- molaoshi - -content: -- import_csv: - content_version: 2024-01-19 19:00:00+00:00 - note_type: Vokabeln - file_patterns: - - '*.txt' - delimiter: "\t" - # Not needed because the CSV contains the deck name - deck_name_pattern: 'UNUSED' - fields_mapping: - - guid - # ignoriere den Kartentyp - - '' - # Dritte Spalte ist Deckname - - deck - - Deutsch - - 简体字 - fields_static: - Schreiben (简体字) anlegen: 'true' - # Mehr optionale Kartentypen aktivieren: - # Hören anlegen: 'true' - # Schreiben (繁體字) anlegen: 'true' - # Radikal finden anlegen: 'true' - # Radikal finden (繁體字) anlegen: 'true' - # Lesen (简体字) anlegen: true - # Lesen (繁體字) anlegen: 'true' - # Lesen (Pīnyīn) anlegen: 'true' - tags: [] - -resource_paths: [] diff --git a/content/Vocabulary-from-Anki/Chinesisch.txt b/content/Vocabulary-from-Anki/Chinesisch.txt deleted file mode 100644 index 179e133..0000000 --- a/content/Vocabulary-from-Anki/Chinesisch.txt +++ /dev/null @@ -1,8 +0,0 @@ -#separator:tab -#html:true -#guid column:1 -#notetype column:2 -#deck column:3 -#tags column:6 -sA:>|UEhWR Basic Chinesisch::Teil 1 Tapir 貘 -fVVAK}&Gs~ Basic Chinesisch::Teil 1 gut 好 diff --git a/content/Vocabulary-from-Anki/README.md b/content/Vocabulary-from-Anki/README.md deleted file mode 100644 index 5eb25e4..0000000 --- a/content/Vocabulary-from-Anki/README.md +++ /dev/null @@ -1,17 +0,0 @@ -# Vocabulary from Anki -This example builds Vocabulary cards from simple Front/Back cards that were -exported from Anki. - -To generate the .txt file, click the wheel when hovering the root of thr deck -you want to export and hit _Export…_ and select _Notes in Plain Text (.txt)_ as -the format. Check everything, e.g. the deck name and unique identifier. - -See [.apkg-spec.yaml](.apkg-spec.yaml) for an example of how to handle such a -file. - -## Images -If you use images, put them into a directory and add that to the resource path. - -See for example -[sinology-1](https://gitlab.phaidra.org/kartenaale/packs/sinology-1/-/blob/main/content/Einf%C3%BChrung-in-die-politische-Geschichte-Chinas/.apkg-spec.yaml) -as an example of how to do this. diff --git a/content/Your-custom-vocabulary/.apkg-spec.yaml b/content/Your-custom-vocabulary/.apkg-spec.yaml new file mode 100644 index 0000000..404113e --- /dev/null +++ b/content/Your-custom-vocabulary/.apkg-spec.yaml @@ -0,0 +1,21 @@ +content_version: 1.0.0 + +templates: +- vocabsimple + +content: +- import_csv: + content_version: 2024-01-19 19:00:00+00:00 + note_type: Vocab simple + file_patterns: + - '*.csv' + delimiter: "," + deck_name_pattern: 'My Chinese Vocabulary' + fields_mapping: + - guid + - Deutsch + - 简体字 + fields_static: {} + tags: [] + +resource_paths: [] diff --git a/content/Your-custom-vocabulary/Chinesisch.csv b/content/Your-custom-vocabulary/Chinesisch.csv new file mode 100644 index 0000000..c49ed14 --- /dev/null +++ b/content/Your-custom-vocabulary/Chinesisch.csv @@ -0,0 +1 @@ +245738aadsfaasdfaswe,tapir,貘 diff --git a/package.json b/package.json index c2c4db7..1587a66 100644 --- a/package.json +++ b/package.json @@ -1,3 +1,3 @@ { - "version": "1.0.0-starter9" + "version": "1.0.0" } -- GitLab