workbook/TODO

   1
   2 This file is our personal scrapbook, listing what we want to do in the
   3 nearby future
   4
   5
   6 * Website
   7
   8 ** mission.html
   9
  10 ** benchmark Schubert
  11
  12
  13 * Bugs
  14
  15 ** pc-solo.ly
  16
  17 ** staff-padding / padding.
  18
  19 * Code
  20
  21 ** \set / \override syntax
  22
  23 * Documentation
  24
  25 ** split refman
  26
  27 ** Sift examples, move into main doc.
  28
  29 * Program reference
  30
  31 ** Prune internals documentation.
  32
  33 ** Move Markup doc to docstrings.
  34
  35 * Release 2.2/3.0
  36
  37 ** upload
  38
  39 ** binaries
  40
  41 ** announce
  42
  43   News: rec.music.compose, comp.os.linux.apps, rec.music.makers(?)
  44
  45   Mail: abcusers, rosegarden, noteedit, tex-music, linux-audio-announce,
  46
  47   Web: freshmeat, linux-sound,
  48
  49 ** translation project.
  50
  51 ** mutopia submissions
  52
  53
  54 * Book
  55
  56 ** Status and planning
  57
  58 [L] The book still needs a lot of work, but it is not insurmountable.
  59 The pieces are there; they need to be re-ordered and integrated
  60 better.
  61
  62 [L] There are still some rough patches - whole pages - that still need
  63 real work.  The general polished sections still have a large number of
  64 English errors.  Some errors collected together; whole sentences need
  65 to be completely rewritten.
  66
  67 [L] This will take an active partnership between the editing staff and
  68 one or more authors.  It will take 2 months or more of a lot of time
  69 (~15hrs a week) on the part of the LilyPond maintainers, and then
  70 another couple of months of occasional follow-up emails as we do the
  71 fine-tooth comb English edits and get it ready for press.
  72
  73
  74 ** Manual structure, fitting pieces together
  75
  76 *** [L] SKIP: Regression Tests for Developers -- input/regression
  77
  78 *** Templates -- input/templates/out-www/collated-files.tely
  79 [L] Appendix to the printed manual.
  80
  81 *** Glossary -- Documentation/user/music-glossary.tely
  82 [L] Appendix to the printed manual.
  83
  84 Get authors and license.
  85
  86 *** Examples  -- input/examples
  87
  88 [L] These (or some of these) need to be integrated into the book.  To
  89 save space, each example should show just one page of music.
  90
  91 [L] The best way is to add an illustrative example as it's own sub-section
  92 within the tutorial, after a section discussing a certain technique,
  93 music issue, or typesetting problem.  For instance, after a discussion
  94 of how to do multi-voice notation, put a half page or one page choral
  95 piece.
  96
  97 [L] I think this extra time is well worth it.  It will add a *lot* of
  98 value to the book relative to the amount of work being done.  (A much
  99 better value/time ratio than the countless necesary-evil hours we
 100 spend doing "fine-tooth comb" English editing.)
 101
 102 [L] Before you spend any time on it, you should post a request to your
 103 mailing list.
 104
 105
 106 *** Compile  -- Documentation/topdocs/INSTALL.texi
 107
 108 [L] Normally, all our technical manuals include a section on How to
 109 Install.  Too terse and UNIX (problems) only.
 110
 111 UNDECIDED: Possibly get info from newweb/site/download/,
 112
 113 *** Program Reference  -- Documentation/user/out-www/lilypond-internals
 114
 115 [L] Big problem.
 116
 117 [L] I leave it up to you to decide which cross
 118 references really must be included and then add the information to the
 119 main text.  Any reference to internal commands that aren't included in
 120 the main text should be cut from the printed version.  We can make a
 121 note in the book that says "for complete information on every single
 122 internal command, see http://www....."
 123
 124 Either add to manual in condensed form (we'll try that first), or
 125 remove all x-references.
 126
 127 *** Tips and Tricks -- input/test/out-www/collated-files.tely
 128
 129 [L] I worry that important updates and helpful advice are lost in
 130 here, instead of integrated into the manuscript.
 131
 132 [L] It sounds like a lot of the material is already completed.  Can you
 133 convert the Templates file into a Texinfo-formatted appendix?
 134
 135 Ask users.
 136
 137
 138 *** SKIP: why switch?  -- newweb/site/switch/advantages.html
 139 *** SKIP: feature list -- newweb/site/about/features.html
 140
 141 [L] Useful source material for me when writing back-cover text, a sales
 142 sheet or ad, but not needing integration into the manual itself.
 143
 144 *** SKIP: crash course -- newweb/site/switch/howto.html
 145
 146 [L] Some part of this might be useful as back-cover text, to help quickly
 147 explain things while someone is standing in a bookstore, thinking
 148 about it.  However, it does not need to be integrated into the
 149 manual.
 150
 151 *** SKIP: faq -- newweb/site/about/faq.html
 152
 153 *** SKIP: essay -- newweb/site/about/automated-engraving/
 154
 155 [L] The majority of the info in this essay has already been added to
 156 the manual.
 157
 158 ** Issues
 159
 160 *** INSTALL.texi -- CD
 161
 162 [L] After reading your notes about the compilation problems, I am even
 163 more committed to doing it as a book&CD.
 164
 165 UNDECIDED: [L] I am not going to bother creating a ready-to-run live-CD.
 166
 167 *** Graphical interfaces
 168
 169         * NoteEdit
 170         * RoseGarden
 171         [* Denemo]
 172