| | 1 | (Sample documentation structure to start Sophie documentation with. Each numbered item will become a page in the wiki. See also [wiki:UNPLANNED_USER_DOC_STRUCTURE/StyleGuide], the style guide for how user documentation should be created. This was created as part of [wiki:UNPLANNED_USER_DOC_STRUCTURE_R0].) |
| | 2 | |
| | 3 | = Sophie Documentation = |
| | 4 | [[BR]] |
| | 5 | |
| | 6 | == 1. Working with Sophie == |
| | 7 | === 1.1. Sophie’s interface === |
| | 8 | === 1.2. Halos and HUDs === |
| | 9 | === 1.3. Flaps, tabs, and palettes === |
| | 10 | === 1.4. The menu bars === |
| | 11 | === 1.5. Keyboard shortcuts === |
| | 12 | === 1.6. Special keyboard interactions === |
| | 13 | === 1.7. Book windows === |
| | 14 | === 1.8. Test mode === |
| | 15 | [[BR]] |
| | 16 | |
| | 17 | == 2. Working with books == |
| | 18 | === 2.1. Making a new book === |
| | 19 | === 2.2. Using book templates === |
| | 20 | === 2.3. Making book templates === |
| | 21 | [[BR]] |
| | 22 | |
| | 23 | == 3. Working with frames == |
| | 24 | === 3.1. Changing the size and position of a frame === |
| | 25 | === 3.2. Setting borders and fills === |
| | 26 | === 3.3. Making links with the link halo === |
| | 27 | [[BR]] |
| | 28 | |
| | 29 | == 4. Working with text == |
| | 30 | === 4.1. Using the character halo === |
| | 31 | === 4.2. Using the paragraph halo === |
| | 32 | === 4.3. Using paragraph styles === |
| | 33 | === 4.4. Using the link halo === |
| | 34 | === 4.5. Searching text === |
| | 35 | === 4.6. Using the spellchecker === |
| | 36 | === 4.7. Using multiple flows === |
| | 37 | === 4.8. Working with media === |
| | 38 | === 4.9. Adding resources to Sophie === |
| | 39 | === 4.10. Using time-based media === |
| | 40 | [[BR]] |
| | 41 | |
| | 42 | == 5. Working with links == |
| | 43 | === 5.1. Using the link HUD === |
| | 44 | === 5.2. The different kinds of link triggers === |
| | 45 | === 5.3. The different kinds of link actions === |
| | 46 | === 5.4. The third field of the link HUD === |
| | 47 | === 5.5. Making more complicated links === |
| | 48 | [[BR]] |
| | 49 | |
| | 50 | == 6. Working with pages == |
| | 51 | === 6.1. Using page templates === |
| | 52 | === 6.2. Using the page structure palette === |
| | 53 | [[BR]] |
| | 54 | |
| | 55 | == 7. Working with embedded books == |
| | 56 | === 7.1. Creating embedded books === |
| | 57 | === 7.2. Displaying embedded books === |
| | 58 | [[BR]] |
| | 59 | |
| | 60 | == 8. Working with timelines == |
| | 61 | === 8.1. The timeline interface === |
| | 62 | === 8.2. Kinds of timelines === |
| | 63 | === 8.3. Using single-page timelines === |
| | 64 | === 8.4. Using multiple-page timelines === |
| | 65 | === 8.5. Controlling timelines === |
| | 66 | [[BR]] |
| | 67 | |
| | 68 | == 9. Working with Sophie Server == |
| | 69 | === 9.1. Using remote objects === |
| | 70 | === 9.2. Comment frames === |
| | 71 | [[BR]] |
| | 72 | |
| | 73 | == 10. Working with reader annotations == |
| | 74 | === 10.1. Using stickies === |
| | 75 | === 10.2. Using the highlighter === |
| | 76 | [[BR]] |
| | 77 | |
| | 78 | == 11. Publishing & Sophie Reader == |
| | 79 | === 11.1. Publishing === |
| | 80 | === 11.2. Sophie Reader === |
| | 81 | [[BR]] |
| | 82 | |
| | 83 | = Anticipated Changes = |
| | 84 | |
| | 85 | Sophie Server and Sophie reader will receive their own documentation as they become finished products. |
| | 86 | |
