ToDo

On any page which needs attention before it is ready for the manual, insert a link to this page by adding:

<div class="editornote">[[ToDo]] explanation of what needs to be done </div>

to that page. Be clear about the changes that are needed. Then anyone who visits this ToDo page can click on 'What Links Here' in the left sidebar to get a list of all pages with work to do comments.

Update

The page is now the link destination for unclassified ToDo's, plus any discussion of ToDo's in general.

It has now been augmented with pages named ToDo-1 and ToDo-2.

Generally, we will ignore ToDo's on translated pages that have a suffix like /fr. Many will be duplicates of ToDos that were on the English page at the time, but it could be dangerous if translators were advised to remove divs that did not require translation. Generally, only the translator can fix ToDo's on a translated page.

ToDo Priorities

P1 on ToDo-1 These would be "release blockers". Since there are no more beta release, these would block any release

• function not documented
• function incorrectly documented
• function correctly documented as far as it goes, but agreement it needs expanding (or possibly, contracting) to prevent reported misunderstandings.
• broken / mistitled links
• out-of-date images that do not show the interface as it will appear on release
• no FAQ for a frequently reported issue

P2 on ToDo-2 These do not block a release. They are higher priority than Px.

• mixed-OS images on the same page
• no FAQ for an occasionally reported issue

Px on this page: Do not block release.

• any "would be nice to do post-2.0" comments
• debate about how exactly to write the text documenting a specific feature
• debate about structure; e.g. (as of April 2011) what to do regarding the Project Window overview page

Decisions

Edit Hint: Uh, aren't these/shouldn't these be on the consistency page?

• We're not documenting all effects or all analyze menu items on a page-of their own. Only the most complex ones that require a screenshot will get that treatment. We don't have the time to do them all. Most effects and most analyze menu items will appear on the relevant page about that menu.
• The reference section should avoid tutorial exposition. It's kept brief, and links to tutorial sections as needed. (Should be viewed intelligently, so as to avoid shunting users around too much, and avoiding creation of half-page "tutorials" for the sake of it which is a significant reason for our duplication problem).

Questions

Some details

Here are some specific ToDo details...

• Timeline needs a simple one sentence explanation that there is also a vertical ruler in a most track views and what it does.Peter 15Dec09 - does it need this? The vertical ruler is not a timeline surely - and thus should not really need mentioning here.
• Index?? Let's get the talk page for it and discuss what we want. - Peter 26Feb08: ready for review, including suggested keywords - please examine the talk page and edit/remove/add suggestions
• Effect Menu needs futher work - it is incomplete Most effects now documented - still a few to do. Need to decide which effects need their own page and which don't, as well as appropriateness of the descriptions. - Bill. Looks done to me - James
• How to get help page needs serious attention Done, mostly. A couple of questions remain - Bill. Peter 15Dec09: looks done to me.
• Recovery page needs writing Peter 14Dec09 I have made a first attempt at this - explaining the buttons and a link to the Wiki for the manual recovery method. Updated by Gale & Bill - greenlighted by Gale
• Preferences some options with no description or inadequate description. Peter 15Dec09: Looks done to me.

Low Priority

• Technical info: nice to have... cepstrum (on plot spectrum), what an FFT is, why dB use logs, 'why you get clicks' when you remove sound.

The html manual distributed with Audacity is primarily the reference section. Tutorials and so on are nice to have with it, but are not essential. These sub-projects are therefore of lower priority.

• Tutorial - Your First Recording has screenshots of many types of connectors. Some text to explain what the differences are and how they are used would be nice, possibly a new page. There is some text already on the main Audacity wiki about this - we want to avoid duplicated effort, so we need to decide whether such text lives there or here.
• There are tutorials linked to from the Old Pages page, which are in an old style. They're not linked to from the Main Page. We need to decide which of these are already sufficiently covered by Dominic's new tutorials, and which need updating. I move that we ditch them. They are well out of date. - James
• Post 1.4.0, generate screenshots of all effects and their parameters automatically, and probably have separate Manual pages for each. Perhaps remind on Audacity devel? Perhaps add as part of a project proposal on GSoC ideas page on main wiki?

Not Needed (yet)

• • Add Screen Capture Feature. Not needed or relevant for 1.4 release builds
  • Add Theme Preferences. Not needed or relevant for 1.4
  • Add SmartRecord Preferences. Not needed or relevant for 1.4
  • Transcription toolbar full version.

Lifted from Main Wiki

Text from the documentation checklist on the main wiki about this manual has been moved here. It makes far more sense to capture the overview of all changes required to the manual in one place, i.e. on this page. The documentation checklist page on the main wiki now points to here for work to do on the manual wiki.

This lifted section is old and could do with some drastic pruning.

Essential Changes to Manual Quick Guide

• Write Unsupported File Format Help for Quick Guide (mention wav, midi, etc).

• • Add Batch Preferences. A lot of this functionality has moved to menu items, and so needs to be described there.
• Update AudioIO Preferences.
• Changes To Track Features
  • Help on Label Track (substantially changed feature). - Not quite done - see the edit hints on the page - GA

• Using Vertical Zooming.
• Explanation of multi clip, including joining of tracks.
• Changes To Toolbars
  • Add Transcription Tool Bar (cut down version)
  • Add Time-Selection Control. Include use of mouse wheel.

Essential Changes to other Manual pages

Latency correction

• what it is and where it is set
• meaning of behind-zero arrows

• Steve 25Apr12: Done here

• why the all-recorded-audio-gone-behind zero dialogue appears
• correct procedure to adjust with Time Shift Tool
• explanation of what happens with latency correction when append-recording.

Bill: I've done the Latency Test page, which covers a lot of this. Do we want another page for Latency Correction? Or perhaps a page on Latency that links to Latency Correction and Latency Test?

---

Selection area issues when dragging

• If you click inside a selection area when dragging, the selection area will move with the clip. Otherwise, the selection area will stay where it is.
• To drag a clip containing a selection area into another track, either click in the track with Selection Tool to remove the selection, or click outside the selection area when dragging.