HackMD
Roadmap
Image Not Showing
Possible Reasons
- The image file may be corrupted
- The server hosting the image is unavailable
- The image path is incorrect
- The image format is not supported
Learn More →
Image Not Showing
Possible Reasons
- The image file may be corrupted
- The server hosting the image is unavailable
- The image path is incorrect
- The image format is not supported
Learn More →
Image Not Showing
Possible Reasons
- The image file may be corrupted
- The server hosting the image is unavailable
- The image path is incorrect
- The image format is not supported
Image Not Showing
Possible Reasons
- The image file may be corrupted
- The server hosting the image is unavailable
- The image path is incorrect
- The image format is not supported
You can use this document like a short reference to all avaliable and planned features. We use it for inspiration, to see what has already been done and what has not.
Material types
richText
- Write text in markdown using common tags:
- h3-h5
### Header with depth level 3 - em
*emphasized text* - strong
**bold text** - blockquote
> quotation text - image
- block image (full width)
- intext image (small)
- custom image with styles (position, size, border, etc)
[image | path/to/file | right | 200 | 100 ]
- unordered list
- ordered list
- horizontal rule (hr)
- strikethrough (del)
~~deleted~~ - link
- to local materials
- to web materials?
- emoji
:smile:
- h3-h5
- Embed video, audio into text by:
- local link
videos/lecture1.mp4 - network link
https://bbc.com.ua/learn-english/001.mp3 - youtube link
youtu.be/videoId - media material (with extra data e.g. timed phrases, quiz, etc)
- local link
- Embed sounded word into text with
[[text]]or[[text | path/to/audio]] - Cards (
image + text + translation + sound)- from other material address
- Embed quiz:
- single correct answer
- ( ) - multiple correct answers (from zero up to count of variants)
- [ ]
- single correct answer
- Exercises
- choose right label
- fill the gaps
- Collapse/Expand (spoiler)
fileCards
Put together small:
- audio file + text + image (into card)
- play by click on it
- exercise
- playback
- play all (like large media)
- speed
- drill/dictation mode
- Multi file relations?
- One image –> multiple audios?
richMedia
Put together large media file + other timed data:
- different sources of media:
- local file
- network file
- youtube
- audio hostings?
- twitter/facebook/vimeo?
- timed phrases (captions/subtitles):
- srt
- vtt
- audacity labels
- ass
- youtube transcript?
1:15 text of phrase
- avatar images for speakers from:
- local file
- network link
- quiz tied to timecode
- playback mode
- speed (playback rate)
- drill/dictation options
- repeat count
- delay length
- delay type
- relative (length of phrase)
- absolute (seconds
- view
- hide video
- book mode (with headers, paragraphs, etc)
exercise
-
given
- audio
- text original/translation
- image
-
required
- audio
- choose
- write?
- text original/translation
- choose
- write
- order
- image
- choose
- timer (hurry up)?
- audio
-
mix different types (audio+text, image+audio)
-
which phrases to get
- random
- preset
-
order of phrases
- random
- preset
-
fake variants
- random
- preset
-
tolerance for user input
- universal (for all languages)
- case insentivity
- diacritics
- stress
- punctuations
- language specific
- module for custom rules
- universal (for all languages)
homePage
-
Simple cover page with:
- title
- background image
- logo image
- 3 separated text blocks (top/middle/bottom)
- avaliable translations list (choose one)
- go next button
-
Advanced index page:
- list of materials with extra fields
- date
- image
- description
- watched/unwatched
- tags
- material type?
- list of materials with extra fields
-
filter/sort by all of these fields
-
search
- titles
- full text
Navigation
Drawer
- logo
- title
- title translation
- list
- chapter
- chapter tr
- subchapter
- subchapter tr
- material type
- translation show/hide switcher
- change translation language switcher
- player settings
References
Ref should open part of other material from other material
- richMedia
- whole material
- one phrase
- range of phrases
- richText
- whole material
- header
- range of paragraphs
- fileCards
- range of items
Translations
Translate main content into other languages, make it looking as parallel texts.
- simple home page
- oneLineOneFile
- media
- phrases
- avatars
- quizes
- inText?
Customization
Styling
Change look of any part of app by editing styles.
- general
- layout
- contentType
- add custom fonts
- separate module for your changes (to simplify updates of ULA core)
Layout
- Change order of elements
image-text –> text-image
original-translation –> translation-original
Localization
- English text
- check spell and grammar mistakes
- separate module with all interface texts
- translate english into other languages
- Russian
- Spain
- Portuguese
- French
- Chinese
- Arabic
- delivery type
- local (prebuild in app)
- download by demand
Progress/errors
- store errors
- where
- what
- how much
- store progress
- timestamps of activities (what did at what time)
- amount of learned materials (count of words, phrases)
- display with graphics/diagrams
- share with friends, teacher
Content store/delivery type
- local file
- web API
- categories
- notifications
File downloader
- local (originally in app)
- web (load while using)
- preload on demand (web –> local by user choise)
Share
Share with friends interesting things:
- preview image
- navigation to particular part of app
- for oneLineOneFile
- for richMedia
- single item or whole material
Social
- make classes around the app
- teacher monitors progress of students
- students help each other
