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

Merge pull request #348 from Aquafina-water-bottle/issue_82_documentation

Browse Source 
README changes: Issue 82 documentation
This commit is contained in:
Alexei Yatskov 2022-09-11 10:59:18 -07:00 committed by GitHub
commit 9f76e5fff2
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 7 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

9
README.md
View File

@ -1859,7 +1859,7 @@ corresponding to when the API was available for use.
* **createModel** * **createModel**
Creates a new model to be used in Anki. User must provide the `modelName`, `inOrderFields` and `cardTemplates` to be Creates a new model to be used in Anki. User must provide the `modelName`, `inOrderFields` and `cardTemplates` to be
used in the model. There are optinal fields `css` and `isCloze`. If not specified, `css` will use the default Anki css and `isCloze` will be equal to `False`. If `isCloze` is `True` then model will be created as Cloze. used in the model. There are optional fields `css` and `isCloze`. If not specified, `css` will use the default Anki css and `isCloze` will be equal to `False`. If `isCloze` is `True` then model will be created as Cloze.
Optionally the `Name` field can be provided for each entry of `cardTemplates`. By default the Optionally the `Name` field can be provided for each entry of `cardTemplates`. By default the
card names will be `Card 1`, `Card 2`, and so on. card names will be `Card 1`, `Card 2`, and so on.
@ -1873,7 +1873,7 @@ corresponding to when the API was available for use.
"modelName": "newModelName", "modelName": "newModelName",
"inOrderFields": ["Field1", "Field2", "Field3"], "inOrderFields": ["Field1", "Field2", "Field3"],
"css": "Optional CSS with default to builtin css", "css": "Optional CSS with default to builtin css",
"isCloze": False, "isCloze": false,
"cardTemplates": [ "cardTemplates": [
{ {
"Name": "My Card 1", "Name": "My Card 1",
@ -2391,6 +2391,11 @@ corresponding to when the API was available for use.
Modify the fields of an exist note. You can also include audio, video, or picture files which will be added to the note with an Modify the fields of an exist note. You can also include audio, video, or picture files which will be added to the note with an
optional `audio`, `video`, or `picture` property. Please see the documentation for `addNote` for an explanation of objects in the `audio`, `video`, or `picture` array. optional `audio`, `video`, or `picture` property. Please see the documentation for `addNote` for an explanation of objects in the `audio`, `video`, or `picture` array.
> **Warning**
> You must not be viewing the note that you are updating on your Anki browser, otherwise
> the fields will not update. See [this issue](https://github.com/FooSoft/anki-connect/issues/82)
> for further details.
*Sample request*: *Sample request*:
```json ```json
{ {