Topic Templates for Categories

Add-ons

Your issue may already be reported!
Please search on the [Forum](https://forums.ankiweb.net/search?expanded=true) before creating one.
* [ ] Did you read the [Getting Help](https://docs.ankiweb.net/getting-help.html)?
* [ ] Can you reproduce the problem after following the steps in [Troubleshooting]?(https://docs.ankiweb.net/troubleshooting.html)?
type or paste the Debug Info here

Anki Desktop

Your issue may already be reported!
Please search on the [Forum](https://forums.ankiweb.net/search?expanded=true) before creating one.
* [ ] Did you read the [Getting Help](https://docs.ankiweb.net/getting-help.html)?
* [ ] Can you reproduce the problem after following the steps in [Troubleshooting]?(https://docs.ankiweb.net/troubleshooting.html)?
* [ ] Did you check the [FAQs](https://faqs.ankiweb.net/)?
* [ ] Did you check the [Platform Notes](https://docs.ankiweb.net/platform/intro.html)?
type or paste the Debug Info here (Help > About or Anki > About menu)

AnkiMobile (iPhone/iPad)

Your issue may already be reported!
Please search on the [Forum](https://forums.ankiweb.net/search?expanded=true&q=%23ankimobile) before creating one.
* [ ] Did you read the [Getting Help](https://docs.ankiweb.net/getting-help.html)?
* [ ] Did you check the [AnkiMobile Manual](https://docs.ankimobile.net/intro.html)?

Suggestions

Your suggestion may already be requested!
Please search on the [Forum](https://forums.ankiweb.net/search?expanded=true&q=%23suggestions%20) before creating one.

## Expected Behavior
<!--- Tell us how it should work -->

## Current Behavior
<!--- Explain the difference from current behavior -->

## Possible Solution
<!--- Ideas on how to implement the addition or change -->

## Context
<!--- Providing context helps us come up with a solution -->

Another alternative for Suggestions:

Your suggestion may already be requested!
Please search on the [Forum](https://forums.ankiweb.net/search?expanded=true&q=%23suggestions%20) before creating one.

**Is your feature request related to a problem? Please describe.**
A clear and concise description of what the problem is. Ex. I have an issue when [...]

**Describe the solution you'd like**
A clear and concise description of what you want to happen. Add any considered drawbacks.

**Describe alternatives you've considered**
A clear and concise description of any alternative solutions or features you've considered.

**Teachability, Documentation, Adoption, Migration Strategy**
If you can, explain how users will be able to use this and possibly write out a version the docs.
Maybe a screenshot or design?

Card Design

Your issue may already be reported!
Please search on the [Forum](https://forums.ankiweb.net/search?expanded=true) before creating one.
* [ ] Did you read [Getting Help](https://docs.ankiweb.net/getting-help.html)?
* [ ] Did you check the [Card Template](https://docs.ankiweb.net/templates/intro.htm)?
* [ ] Did you check the [FAQs](https://faqs.ankiweb.net/)?
* [ ] For Advanced Users, did you check the Mozilla Reference for [HTML](https://developer.mozilla.org/docs/Web/HTML/Reference), [CSS](https://developer.mozilla.org/docs/Web/CSS/Reference), and [JavaScript](https://developer.mozilla.org/docs/Web/JavaScript/Reference)?

Syncing & AnkiWeb

Your issue may already be reported!
Please search on the [Forum](https://forums.ankiweb.net/search?expanded=true) before creating one.
* [ ] Did you read [Getting Help](https://docs.ankiweb.net/getting-help.html)?
* [ ] Can you reproduce the problem after following the steps in [Troubleshooting](https://docs.ankiweb.net/troubleshooting.html)?
* [ ] Did you check the [FAQs](https://faqs.ankiweb.net/)?

AnkiDroid (Android)

Your issue may already be reported!
Please search on the [Forum](https://forums.ankiweb.net/search?expanded=true&q=%23ankidroid%20) before creating one.
* [ ] Did you read the [Getting Help](https://docs.ankiweb.net/getting-help.html)?
* [ ] Did you check the [AnkiDroid Support](https://ankidroid.org/docs/help.html)?
type or paste Debug Info here (Settings > Advanced > About AnkiDroid)

Scheduling

Your issue may already be reported!
Please search on the [Forum](https://forums.ankiweb.net/search?expanded=true) before creating one.
* [ ] Did you read the [Getting Help](https://docs.ankiweb.net/getting-help.html)?
* [ ] Can you reproduce the problem after following the steps in [Troubleshooting](https://docs.ankiweb.net/troubleshooting.html)?
* [ ] Did you check the [FAQs](https://faqs.ankiweb.net/)?
* [ ] Did you check the [Deck Options](https://docs.ankiweb.net/deck-options.html)?

Extra

Why im putting … steps in Troubleshooting, when Getting help already mentions it?
To double-check, because most problems are solved by it

What about International users that don’t know English?
Most posts are in English, the exception can translate using their browser translator or DeepL, or simply writing it over, we will help anyway.

The idea came when was learning about bug report templates on ankidroid, used
GitHub - stevemao/github-issue-templates: 🔣 A collection of GitHub issue, pull request and security templates for reference

Check out previous Site Feedback suggestions

Example of Toggle in Markdown (It is clickable)

5 Likes

Thanks, it’s a good idea, and I was not aware this was an option. I’ll look into when I have a chance.

These should now be active.

2 Likes

Problems found in the templates and their fixed versions (ready to copy and paste)

Anki Desktop Add-ons
Hyperlink broken by added space

* [ ] Can you reproduce the problem after following the steps in [Troubleshooting](https://docs.ankiweb.net/troubleshooting.html)?

AnkiMobile (iPhone/iPad)
Fixes the hyperlink and make them in one line

Your issue may already be reported! Please [search](https://forums.ankiweb.net/search?expanded=true&q=%23ankimobile) before creating a new post.

Card Design Syncing & AnkiWeb
Forgotten to add “the” to match others categories, alternatively, we can remove all “the”

* [ ] Did you read the [Getting Help](https://docs.ankiweb.net/getting-help.html)?

AnkiDroid (Android)
Could you add ``` to become a preformatted text in shell

Current behavior:
type or paste Debug Info here (Settings > Advanced > About AnkiDroid)

Expected behaviour:

type or paste Debug Info here (Settings > Advanced > About AnkiDroid)

Don’t:
type or paste Debug Info here (Settings > Advanced > About AnkiDroid)

Solution:


Add-ons Suggestions Card Design Syncing & AnkiWeb Scheduling
some template has Forum has hyperlink instead of search, others ends with … creating one or … creating a new post

This make as all templates will have search as hyperlinked and will end as … creating a new post

Your issue may already be reported! Please [search](https://forums.ankiweb.net/search?expanded=true) before creating a new post.

1 Like

Thanks, I’ve updated them.

2 Likes

Today, I had my first brush with the topic templates as OP! I have a bit of feedback in case it’s useful for fine-tuning –

  1. Is it intended that the user leaves the template in their post to certify that they’ve taken those steps? I’ve noticed most users don’t.
  2. @NameLessGO, you mentioned that the Markdown “Toggle” is clickable? But it isn’t. In the edit window, the user sees the raw Markdown [ ], and it’s not clear what to do to “tick” it – which eventually prompted me to delete the template entirely, since it didn’t seem like it was intended to be used like an actual checklist.
  3. Discourse has a very useful feature which pops up a list of maybe-similar posts as soon as I start typing a title. But the presence of the template appears to be breaking that. The maybe-similar candidates were all unrelated, except they had the same template text in them.
    image

I suppose the solution to all of these is the pretty much the same – make it explicit that the user can/should delete the template before posting, or make it be excluded from the post in some other way.

The “checklist”-iness of it is also not necessary as long as it doesn’t work.
(I did eventually figure out that if there was no space in the brackets, and you add x or X, Markdown does turn it into a ticked box – [x] – doesn’t seem to work with any other characters. So I suppose the other idea would be to remove the spaces from the templates.)

image
Checklist docs

Suggestion:

Please mark the following with: (optional line)
[x] or [X] = Yes
[ ] = No

such as

Your issue may already be reported!
Please search on the [Forum](https://forums.ankiweb.net/search?expanded=true)
before creating one.

[x] or [X] = Yes
[ ] = No

* [ ] Did you read the [Getting Help](https://docs.ankiweb.net/getting-help.html)?
(optional line break)
* [ ] Can you reproduce the problem after following the steps in [Troubleshooting]?(https://docs.ankiweb.net/troubleshooting.html)?

...

one mistake that was done was keeping the list close together, could we space out like the example above


Live preview:

Your issue may already be reported! Please search before creating a new post.

or = Yes
= No

I still think that non-breakage of the Discourse similar-posts feature should be considered – but if that’s the way you want to go –

  • You don’t need to offer them both upper and lower-case x as examples. We know it doesn’t matter which it is, so just show them one –
    Use an X to mark the things you have tried before posting here
  • Take the spaces out of your brackets. It’s an unnecessary annoyance to have to highlight or delete the space to make sure there’s only an x in the brackets. Better to make it a place you click and type the x.

Requiring users to check the boxes increases the chances they’ll read the steps, but it does make the posts noisy, and breaks the similar-post feature as has been pointed out. What do people think about adding a line at the top like the following?

Please read the following, then delete this text and explain your problem in as much detail as you can.

2 Likes

Great! Or even?
“… do the following …”

1 Like

I’ve changed the template for the Anki Desktop category. Does that look ok to everyone? If so I’ll go and update the other categories as well.

I personally love secret-Markdon numbering, but I would use real numbering for the list, since users will see the raw text.
image

A period on #5?

And is there a way to remove the redundancy in #1 between “before posting” and “search before creating a new post”? How about just “Search these forums.”?

1 Like

Thanks, good points.

1 Like

This topic was automatically closed 30 days after the last reply. New replies are no longer allowed.