Docs: Add examples of using other models to README

[einarpersson]

Hi!

How do I add something like a two-way front/back card? I only use the GUI for that and not apy since i'm not sure. I think it would be great to just add one example with add together with the --model argument (two-way, and perhaps cloze if it is even possible?).

Thanks!

[lervag]

Hi!

You can use any model. But you should be aware that it is important to know the distinction between cards and notes. What you are adding are notes. Different note types/models will create different amount of cards for each note. A regular Basic type will usually just create a single card, whereas a Cloze note may create many cards.

To create a two-way front/back card you first need to know which model this is. I believe the "standard" or default model for two-way cards are named "Basic (and reversed card)". Thus, to create such a note, you use input like this:

model: Basic (and reversed card)
tags: mytag

# Note

## Front

This is my front.

## Back

This is my back.

# Note

## Front

This is my second front.

## Back

This is my second back.

or

# Note
model: Basic (and reversed card)
tags: mytag

## Front

This is my front.

## Back

This is my back.

Does this answer your question?

I guess you are right that I could add an example in the docs. Please feel free to suggest where it makes sense to do so.

[einarpersson]

Thank you for your response. I'm sorry to say that I'm still a bit confused :)

To create a two-way front/back card you first need to know which model this is.

That is why I added #121 - I don't know what exact model names are available. But I now realized that just running apy shows the models in the summary. Could still be nice to have a list-models for sake of completeness though.

From a practical level I suppose that settles it. I mostly use Basic, and sometimes "(and reversed)" and "Cloze" (would be nice with a Cloze example also!). Using presets would make it much more convenient also.

You can stop reading here if you want. From here on are just me trying to get my mental model right.

---

But okey so those model names are the 'keys'. If I were to mistype e.g. model: Basic (and revrsed card) then... what would happen? the card would still upload and be added but the anki app/gui would not know how to present it? or would the database refuse? or would apy refuse?

Does apy provide builtin parsers for standard builtin models (Basic, Cloze, ...)?

Is note type == model? (anki docs)

how do custom note types come in to the picture? If i were to create a custom note type in anki GUI, would it "show up" and somehow be possible to use with apy from the get go or would i have to create some kind of parser for that? or vice versa, can i create a custom model here in apy and it "just works" in the GUI or do i need to replicate some work in both worlds?

[lervag]

Thank you for your response. I'm sorry to say that I'm still a bit confused :)

No problem, I'll try to help.

To create a two-way front/back card you first need to know which model this is.

That is why I added #121 - I don't know what exact model names are available. But I now realized that just running apy shows the models in the summary. Could still be nice to have a list-models for sake of completeness though.

Yes, apy or apy info gives the model names. But I also added list-models as suggested in #121. Thanks for the suggestions!

From a practical level I suppose that settles it. I mostly use Basic, and sometimes "(and reversed)" and "Cloze" (would be nice with a Cloze example also!). Using presets would make it much more convenient also.

The cloze example is really exactly as explained in the Anki manual.

model: Cloze
tags: mytag, othertag

# Note

## Text (THE FIELD NAME HERE IS NOT IMPORTANT)

{{c1::Canberra was {{c2::founded}}}} in 1913

Or {{c3::REPLACE}} here.

## Extra
Extra information goes here.

But okey so those model names are the 'keys'. If I were to mistype e.g. model: Basic (and revrsed card) then... what would happen?

You would get an error and the note would not be added. I believe it would be a safe error, but if you use e.g. apy add or apy add-single, you might loose the input you created. This is why I always use apy add-from-file and create the new notes in a separate file first.

Does apy provide builtin parsers for standard builtin models (Basic, Cloze, ...)?

No, apy doesn't really do or parse anything. We only send the new note data into the Anki database using the Anki APIs.

Is note type == model?

Yes!

how do custom note types come in to the picture? If i were to create a custom note type in anki GUI, would it "show up" and somehow be possible to use with apy from the get go or would i have to create some kind of parser for that?

Yes, if you add a custom note type, it will be available to apy.

or vice versa, can i create a custom model here in apy and it "just works" in the GUI or do i need to replicate some work in both worlds?

No, you can't create custom models with apy. apy does not allow to create new models, but you can rename models with apy model rename and you can edit a models CSS with apy model edit-css.

[lervag]

Feel free to reopen if I mistakenly closed this too soon!

[einarpersson]

Thank you so much!

I hope you can use some of this confusion in the readme so that it benefits more than just me. I think it can be good to clarify what you can and cannot do through apy (not create new models, as in your last example).

[lervag]

I've added a few examples to the README now. Let me know if it looks like what you had in mind.

[wytchblade]

I'm a bit confused on how to actually "review" the cards or notes once I have added them to the anki database? Can you clarify how this is done?

(also, is it possible to add images to notes/cards in the basic model?)

[lervag]

I'm a bit confused on how to actually "review" the cards or notes once I have added them to the anki database? Can you clarify how this is done?

This would deserve a separate issue. But basically: apy does not allow you to do your Anki reviews in the terminal. Sorry!

apy is designed to help maintain and develop your Anki notes/decks. I personally use Ankidroid to do my reviews, and while doing reviews I sometimes mark or flag my cards and then use apy to rephrase or split or improve questions/notes.

And sorry, I think calling it apy review was a bad design choice that is understandably confusing.

(also, is it possible to add images to notes/cards in the basic model?)

I've answered that in your other issue: #128.

[wytchblade]

@lervag Thank you for your response! Ankidroid is a fantastic way to do reviews, I will implement that in my review workflow.

[lervag]

My pleasure :)