Plan for P1/P2 clean-up

Permanent P1's

• Perform a link check using Xenu or other software.

• Check at Code Review 2.1.1 that there are no commits listed in "Not assessed" and that Status reads per the latest commit at https://code.google.com/p/audacity/source/list.

• Change the version number on the front of the Manual from "Audacity 2.x.x-alpha Development Manual" to "Audacity 2.x.x Manual" (whatever the current release is).

• Change the version number of the Manual at Unzipping the Manual in the "x"'s as below:
  • http://sourceforge.net/projects/audacity/files/audacity/2.x.x/audacity-manual-2.x.x.zip/download

Gale 06Feb15: I can recall writing instructions for dumping the Manual on Mac, and thought those instructions were linked to here. Please advise if anyone can shed any light on that.

• Until we have a separate subdomain for the released and alpha Manual, $wgSitename in LocalSettings.php is set to "Audacity Development Manual" to make clear what it is. However this means that for the few minutes while the Manual is dumped for release, Gale or Steve need to change $wgSitename to "Audacity Manual".

After release

• Log in to https://www.virustotal.com/en/, upload the new Windows EXE file and scan it. On the results page, add a comment in the form

#audacity x.x.x for Windows (EXE)

where x.x.x is the release number. This scan result can then be found by users following the instructions on http://manual.audacityteam.org/o/man/faq_about_audacity.html#spyware to locate Audacity scan results.

• Change all version numbers on the front page of the Manual as in the "x" as below. Typically, this would increment just the third number by 1:
  • Audacity 2.x.x-alpha Development Manual.
  • This online Manual is only for the latest 2.x.x-alpha development code. The online Manual for the current 2.x.x release is here. Click here for legacy 1.2 documentation.
  • Use Help > Manual (in browser) in the current 2.x.x release to access an installed copy of the Manual.
  • You can download and install the 2.x.x Manual if the Manual is not installed.

P1

• Index of Effects, Generators and Analyzers: new entries need adding to the table for: "Limiter", "Crossfade Clips" and "Classic Filters"
  • Gale normally does this as he has a tool that makes this easy

P2s that may block a release

• Mixing Audio Tracks: There is no mention here or in Tracks Menu of how render handles white space before the audio begins or audio before zero. Should there be? Current behavior following r11248 is to preserve the clip length by no longer rendering white space between time zero and first audio as silence, and to preserve audio before time zero instead of discarding it. So people who want to export tracks with silent lead-ins preserved now have to generate silence after rendering. I think that tip at least should be in this page.
  • Peter 04Feb14: we have carried this issue through several releases, since December 2011. It has never been a blocker previously.
• DC offset: need to discuss naturally occurring offset recordings
  • Peter 29Jan15This has been an ongoing unresolved ednote discussion since late 2012
• Spectral Selection: details that need sorting
• Modules Preferences: the page is now accurate (afaict) but it only documents default behavior i.e. no shipped modules. Gale thinks we need a non-default Prefs image showing mod-nyq-bench enabled

P2 proofread/review needed

See Pages that link to "ToDo-2R"

• Help Menu: Generate Support Data... I have written something about this (with images) is it sufficient? Is it accurate?
• Languages: Audacity language can now be chosen in the Windows installer

Placeholders

General Placeholders

See Pages that link to "ToDo-2P"

P1 placeholders in Wiki for pages for update after 2.1.1 is released

The following pages will need updating after 2.1.1 is released for the new Manage Effects/Generators/Analyzers method of installing plug-ins.

• Nyquist Plug-ins
• Vocal Removal Plug-ins
• Vamp Plug-ins
• Audio Units
• Ladspa Plug-ins
• VST Plug-ins
• Download Nyquist Plug-ins

Placeholder for WDM-KS

WDM-KS is definitely turned off for 2.1.0

The following pages currently have P2s associated with WDM-KS that may become P1s:

• Glossary
• Device Toolbar
• Devices Preferences
• Tutorial - Selecting Your Recording Device
• Tutorial - Recording Computer Playback on Windows

Wiki P2s re WDM-KS

• Windows Vista OS
• MultichannelRecording
• Windows 7 OS

These above three P2s in the Wiki - all relate to WDM-KS

P2 placeholders for VST presets Mac bug

• In Effect Menu#vst_presets - for removal of Mac-only advice if file extension bug is fixed

P2 placeholders for bug 825

• Sync-Locked Track Groups The "Editing a clip can move other clips" option in Tracks Preferences seems to override Sync-Locked Track Groups except where bugs cause other behavior. Probably the behavior is too buggy and confusing to be documented now, so this is a placeholder for when the behavior is bug fixed and better signposted.
  • Peter 29Jan15: Logged as P3 on Bugzilla #825
• Tracks Preferences: The "Editing a clip can move other clips" option in Tracks Preferences seems to override Sync-Locked Track Groups except where bugs cause other behavior. Probably the behavior is too buggy and confusing to be documented now, so this is a placeholder for when the behavior is bug fixed and better signposted.
  • Peter 29Jan15: Logged as P3 on Bugzilla #825

P2 placeholder for Audacity compilation on Linux against FFmpeg

• Gale 10Sep14: FAQ:Installation_and_Plug-Ins#FFmpeg version support - Placeholder P2 to change the text about dynamic loading if bug 540 is fixed and to monitor compiling status on different distros.

Permanent P1's completed

None

Completed items

• P1 Effect Menu: The "Manage..." needs to be added to this page and carefully documented.
• P1 Index of Effects, Generators and Analyzers: The "Manage..." needs to be added to this page and carefully documented.
• P1 FAQ:Installation and Plug-Ins Plug-in options now. replaced now with the "Manage..." mechanism
• P1 Effects Preferences: Register Effects is now the Manage... dialog
• P1 Undo, Redo and History: New Mac images and text needed for total space used
• P1 Spectrograms Preferences: The nomenclature for "zero padding" was recently still under discussion. Spectrogram View is using "'Vertical smoothing factor" - now that wef 15Jun we are "frozen" the next nightly should contain the nomenclature to be used in 2.1.1
  • In the latest nightly 15Jun15 r96d3c40 Paul is still using "zero padding".
• Zooming: behaves differently when "Enable scrolling left of zero" is turned on in Tracks Preferences - fixed with a note div
• Effect Menu: LV2 Effect Options missing.