|
CreatingALesson
How to create the lesson plan.
Creating a LessonThe lessons are written in a YAML file with a name like "beginner-lessons.yaml". The first lesson in the file needs to have have all the possible settings set. Following lessons copy the current settings from the previous lesson, unless changed explicitly, thus saving typing. (this could be done with YAML syntax as well, but I found it too complicated for most people). DetailsExample: first part of beginner-lessons.yaml lessons:
- allow_errs: No
ignore_accent: Yes
ignore_case: Yes
ignore_whitespace: Yes
space_is_return: Yes
new_keys: "fj"
old_keys: ""
text: "aaa ddd fff"
instructions: "Instructions: Type the text above.
Your fingers must be on the home row as shown in the image below.
Use your left and right index fingers.
%(will_start)s"
preamble: ""
postamble: "Great!\nNow we add the spacebar.\nYou can hit it with either thumb."allow_errs Force the user to correct errors typed on their own. Otherwise, it will just flash whenever they type an error. ignore_accent If they type the character and it's missing the accent, accept it as if they typed it in correctly. ignore_case If the user types the character in the wrong case, accept it as if they typed in the correct character. ignore_whitespace If the user forget to type in the spacebar, type it in for them. space_is_return The user can type either spacebar or the enter key at the end of the line. new_keys The new keys the user is learning now. The lesson must contain these keys. old_keys Keys that the user has already learned. It's ok if some of these keys does not appear in the lesson. Think of them as fill in characters. text Text to user or a function to use. Functions include
instructions The text that appears below in a box. preamble The instructions that appear before the lesson starts. Appears in a dialog box at the end of the previous lesson (near the bottom). postable Information about the text they just entered. Appears in a dialog box at the end of the lesson (near the top). Typing LessYou must have a strings section a the start where you can place comment pieces of text: # Strings are pieces of text that repeat in various lessons. strings: will_start: "The timer starts when you start typing." dont_look: "Don't look down at the keyboard! You can look instead at the one shown on the screen." In sections like preamble you can enter %(will_start)s" wherever you want the will_start text to appear. Testing Your WorkIt's possible to create a broken lesson and going through all the lessons manually would be a pain. To test your lesson, name it something like 'beginner-lessons.yaml' and then run: $ ./lessons.py --lang en --kbd us --out sample.txt $ less sample.txt ------------------------------------------ Lesson: 1 Preamble: Instruction: Instructions: Type the text above. Your fingers must be on the home row as shown in the image below. Use your left and right index fingers. The spacebar is not required. The timer starts when you start typing. Text: fff fff fff jjj jjj jjj fff fff jjj jjj ff ff jj jj ff jj ff jj fj fj jf jf fjf fjf fjf jfj jfj jfj Postamble: Great! You've learned your first two keys. ------------------------------------------ Lesson: 2 Preamble: Now we'll add the spacebar. You can hit the spacebar with either thumb. Instruction: Now the spacebar is required. You can hit the spacebar button with either thumb. The timer starts when you start typing. Don't look down at the keyboard! You can look instead at the one shown on the screen. Text: fff fff fff kkk kkk kkk fff fff kkk kkk ff ff kk kk ff kk ff kk fk fk kf kf fkf fkf fkf kfk kfk kfk Postamble: Ok, we've only done two keys and the spacebar so far. ------------------------------------------ etc. |
Can you please provide a way to create the ChangeLog? file? I tried installing the program but keeps on returnining that error.
Thank you!