alex/anki-connect
1
Fork 0
Code Releases 5 Activity

changes from review

Browse Source 
single quotes
updated readme
This commit is contained in:
Andreas Kienle 2020-02-25 11:22:34 +01:00
parent eafd3c94dd
commit d40a905f20
2 changed files with 22 additions and 13 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

33
README.md
View File

@ -926,12 +926,12 @@ guarantee that your application continues to function properly in the future.
the created note created on success, and `null` on failure. the created note created on success, and `null` on failure.
AnkiConnect can download audio files and embed them in newly created notes. The corresponding `audio` note member is AnkiConnect can download audio files and embed them in newly created notes. The corresponding `audio` note member is
optional and can be omitted. If you choose to include it, the `url` and `filename` fields must be also defined. The optional and can be omitted. If you choose to include it, it should contain a single object or an array of objects
`skipHash` field can be optionally provided to skip the inclusion of downloaded files with an MD5 hash that matches with mandatory `url` and `filename` fields. The `skipHash` field can be optionally provided to skip the inclusion of
the provided value. This is useful for avoiding the saving of error pages and stub files. The `fields` member is a downloaded files with an MD5 hash that matches the provided value. This is useful for avoiding the saving of error
list of fields that should play audio when the card is displayed in Anki. The `allowDuplicate` member inside pages and stub files. The `fields` member is a list of fields that should play audio when the card is displayed in
`options` group can be set to true to enable adding duplicate cards. Normally duplicate cards can not be added and Anki. The `allowDuplicate` member inside `options` group can be set to true to enable adding duplicate cards.
trigger exception. Normally duplicate cards can not be added and trigger exception.
*Sample request*: *Sample request*:
```json ```json
@ -952,14 +952,14 @@ guarantee that your application continues to function properly in the future.
"tags": [ "tags": [
"yomichan" "yomichan"
], ],
"audio": { "audio": [{
"url": "https://assets.languagepod101.com/dictionary/japanese/audiomp3.php?kanji=猫&kana=ねこ", "url": "https://assets.languagepod101.com/dictionary/japanese/audiomp3.php?kanji=猫&kana=ねこ",
"filename": "yomichan_ねこ_猫.mp3", "filename": "yomichan_ねこ_猫.mp3",
"skipHash": "7e2c2f954ef6051373ba916f000168dc", "skipHash": "7e2c2f954ef6051373ba916f000168dc",
"fields": [ "fields": [
"Front" "Front"
] ]
} }]
} }
} }
} }
@ -996,14 +996,14 @@ guarantee that your application continues to function properly in the future.
"tags": [ "tags": [
"yomichan" "yomichan"
], ],
"audio": { "audio": [{
"url": "https://assets.languagepod101.com/dictionary/japanese/audiomp3.php?kanji=猫&kana=ねこ", "url": "https://assets.languagepod101.com/dictionary/japanese/audiomp3.php?kanji=猫&kana=ねこ",
"filename": "yomichan_ねこ_猫.mp3", "filename": "yomichan_ねこ_猫.mp3",
"skipHash": "7e2c2f954ef6051373ba916f000168dc", "skipHash": "7e2c2f954ef6051373ba916f000168dc",
"fields": [ "fields": [
"Front" "Front"
] ]
} }]
} }
] ]
} }
@ -1056,7 +1056,8 @@ guarantee that your application continues to function properly in the future.
* **updateNoteFields** * **updateNoteFields**
Modify the fields of an exist note. Modify the fields of an exist note. You can also include audio files which will be added to the note with an
optional `audio` property. Please see the documentation for `addNote` for an explanation of objects in the `audio` array.
*Sample request*: *Sample request*:
```json ```json
@ -1069,7 +1070,15 @@ guarantee that your application continues to function properly in the future.
"fields": { "fields": {
"Front": "new front content", "Front": "new front content",
"Back": "new back content" "Back": "new back content"
} },
"audio": [{
"url": "https://assets.languagepod101.com/dictionary/japanese/audiomp3.php?kanji=猫&kana=ねこ",
"filename": "yomichan_ねこ_猫.mp3",
"skipHash": "7e2c2f954ef6051373ba916f000168dc",
"fields": [
"Front"
]
}]
} }
} }
} }

2
plugin/__init__.py
View File

@ -485,7 +485,7 @@ class AnkiConnect:
ankiNote[field] += u'[sound:{}]'.format(audioFilename) ankiNote[field] += u'[sound:{}]'.format(audioFilename)
except Exception as e: except Exception as e:
errorMessage = str(e).replace("&", "&amp;").replace("<", "&lt;").replace(">", "&gt;") errorMessage = str(e).replace('&', '&amp;').replace('<', '&lt;').replace('>', '&gt;')
for field in audio['fields']: for field in audio['fields']:
if field in ankiNote: if field in ankiNote:
ankiNote[field] += errorMessage ankiNote[field] += errorMessage