-
-
Notifications
You must be signed in to change notification settings - Fork 62
5. Workflow Setup
This page is under construction. Certain sections are yet to be finalized and supplementary images are not yet included.
This section is a deep dive into the key concepts of the application which allow for automation of card editing and export.
Export profiles are mappings of Creator Fields in jidoujisho to the fields of their Anki note type.
If a user already has a template that they use for Anki export, they may map the fields that the app handles to the appropriate fields of their note type by tapping on the upper-rightmost button of the main menu and selecting Export profiles. Users may create a new profile based on a certain note type that they have, and assign appropriate fields.
For example, if a user's note type consists of Front and Back, they may assign these fields to have the Term and Meaning fields respectively.
If a note type's number of fields changes in AnkiDroid and this causes a mismatch between the number of fields for an export profile used in jidoujisho, a warning message will appear informing the user that all of the fields for their export profile have been blanked and will require reassignment.
Fields are pre-filled based on the term selected on Instant Export or prior to opening the Card Creator. In order to include a field for card export, it must be included in the Card Creator and mapped in the currently selected export profile.
Enabled fields may also be collapsed in order to reduce clutter during editing. The user may use the Clear button on the top-right of the Card Creator in order to wipe hidden fields quickly when manually editing a card.
The app currently supports the following fields:
- Term: Dictionary headword or phrase.
- Sentence: Subtitles, book excerpts and other contextual information.
- Reading: Text form of the pronunciation or speech pattern of the term.
- Meaning: All dictionary definitions of a term.
- Expanded Meaning: Dictionary definitions only from expanded dictionaries.
- Collapsed Meaning: Dictionary definitions only from collapsed dictionaries.
- Hidden Meaning: Dictionary definitions only from hidden dictionaries.
- Context: Name of the source media being played.
- Notes: Supplementary information or personal observations.
- Tags: Organise notes in a deck with space-delimited labels.
- Furigana: Pre-fills HTML to export for furigana. See documentation for required CSS.
- Pitch Accent: Pre-fills HTML to export for pitch accent diagrams. See documentation for required CSS.
- Image: Visual supplement. Text field can be used to enter search terms for image sources.
- Term Audio: Audio pertaining to the term. Text field can be used to enter search terms for audio sources.
- Sentence Audio: Audio pertaining to the sentence. Text field can be used to enter search terms for audio sources.
If you wish that the app supported a certain field for card editing and export, see the equivalent Development section.
Quick Actions allow for instant card creation and other automations to be used on dictionary search results. A profile allows for up to six slots for Quick Actions.
The ability to use Instant Export or open the Card Creator with appropriate information for a dictionary search result are examples of Quick Actions. The application currently supports the following actions:
- Play Audio: Instantly plays audio from the assigned auto enhancement, and if not, try valid manual enhancements as audio sources.
- Share: Opens a menu to share a headword, reading and meaning for a dictionary search result.
- Add To Stash: Adds the dictionary term to the Stash which the user can use and export later.
- Copy To Clipboard: Copies the headword to the clipboard.
- Instant Export: Applies auto enhancements and exports the dictionary search result as is.
- Card Creator: Opens the Card Creator which allows the user to adjust the card before export and apply any manual enhancements.
If you wish that the app had a certain quick action that can be performed on dictionary search results, see the equivalent Development section.
Enhancements enable the automation of field editing prior to card creation.
When editing enhancements, users may pick the right slots of a field for manual use of an enhancement. The enhancement in the left slot of a field is automatically applied in instant card creation, upon opening the Card Creator or selecting a new word in the Card Creator upon dictionary search.
If a user is unsure what a certain enhancement does, they may unassign it and read the description of it upon reassignment or long press the button in the Card Creator to reveal its name.
Enhancements are tied to their appropriate fields. For example, the Image field can be used to enter a search term for a Bing image search, or have enhancements for cropping images, taking a picture with a camera or picking an image file. Similarly, the Term Audio field can be used to record audio or search for audio for the current word. The Term field allows users to search for dictionary results with the current value in its text field, or get an appropriate example sentence for a term.
The app includes the following enhancements:
- Audio Recorder: Record and use audio captured from the device microphone.
- Bing Images Search: Search Bing for images with the current image query or the word.
- Camera: Take a new photo to use as the new image.
- Clear Field: Quickly empty the content of a field.
- Crop Image: Crop the current selected image.
- Forvo Audio: Get word audio from Forvo.
- Image Search Term Picker: Select an image search term from all text currently in the Card Creator.
- ImmersionKit: Get example sentences complete with an image and audio.
- JapanesePod101 Audio: Search for matching word pronunciations from JapanesePod101.
- Massif Example Sentences: Get curated example sentences via Massif.
- Open Stash: View and manage previously stashed text.
- Pick Audio: Pick an audio file to use with an external picker.
- Pick Image: Pick a new image to use with an external picker.
- Save Tags: Persist the current text in the Tags field.
- Search Dictionary: Search the dictionary with the content of a field.
- Sentence Picker: Pick sentences delimited by punctuation and spacing.
- Tatoeba Example Sentences: Pick example phrases and sentences from Tatoeba.
- Text Segmentation: Search or select a new term from segmented text.
If you wish that the app had a certain enhancement, see the equivalent Development section.
Now that you're more familiar with the app's automated card creation capabilities, you can now go ahead and using the app with media sources. See the next section on Viewing Media.