Plan for P1/P2 clean-up

Permanent P1's

• Perform a link check using Xenu or other software.
  • Peter 10Feb15: Running a Xenu check right now - I've found and crushed a few dead links, it's an arduous process as the vast majority of the reporting duff links relate to translated pages

• 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

• Effect Menu: The "Manage Effects" needs to be added to this page and carefully documented.
• Index of Effects, Generators and Analyzers: The "Manage Effects" needs to be added to this page and carefully documented.
• Index of Effects, Generators and Analyzers: bew 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
• Help Menu: Generate Support Data... - to be written
• Languages: Audacity language can now be chosen in the Windows installer, so this needs rewriting for Win.
• FAQ:Installation and Plug-Ins Plug-in options now. eplaced now with the "Manage Effects" mechanism
• Effects Preferences: Register Effects is now the Manage Effects dialog

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 behaviour 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
• Zooming: behaves differently when "Enable scrolling left of zero" is turned on in Tracks Preferences
• Spectral Selection: details that need sorting

P2 proofread/review needed

See Pages that link to "ToDo-2R"

Placeholders

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 behaviour. Probably the behaviour is too buggy and confusing to be documented now, so this is a placeholder for when the behaviour 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 behaviour. Probably the behaviour is too buggy and confusing to be documented now, so this is a placeholder for when the behaviour 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.

General Placeholders

• Meter Toolbars - consider a proper rename/move to replace the DISPLAYTITLE once 2.1.0 is out
• FAQ:Recording - Troubleshooting#pauses: This probably wants "pausing" split into a separate FAQ and the formatting improved.
• Regular Interval Labels Gale 14Oct14: Monitor Bug 768 and remove the "currently necessary" sentence if the bug is fixed.
• Tracks Menu: Gale 12Aug13: There is a strong case for an examples page since some users shy away from the align commands as they are thought to be complex.
• Tutorial - Recording audio playing on the computer: maybe mention that audio can be ripped from DVDs with details
  • Gale: Probably needs a Wiki page first, in view of the complications. Been on my list for ages.
• Tutorial - Copy and paste a section of audio: Gale 15Apr13: wrote "This is orphaned and not as good as it could be. The best suggestion at the moment seems to be to tweak it and move it into Tutorial_-_Editing_an_Existing_File with a longer term intention of some Manual or more likely Wiki material on repairs including drop-ins. See http://forum.audacityteam.org/viewtopic.php?p=210332#p210332 for some other suggestions."
  • Peter 23Apr13: As an orphaned page this is clearly not a release-blocker.
• Transcription Toolbar: This is a placeholder P2 "Having to click the Play-at-Speed button to change speed was a change made to prevent a freeze on Linux with some buggy versions of PulseAudio. Previously, dragging the slider restarted playback. Please monitor this and change the Manual if the behaviour is changed back."
  • Peter 23Apr13: Not a release-blocker.
• Keyboard Shortcut Reference: When Bug 133 is fixed, remove "You need to then use the Play-at-speed shortcut above to restart playback at the new speed." from the "Increase/decrease playback speed" shortcuts.
• Splitting a recording into separate tracks: replace the references to the two Finders with Steve's new Album Track Marker when it gets released.
  • Peter 22Aug13: Moved to placeholder section as Album Track Marker will not be in 2.0.4/2.0.5/2.0.6 (as discussed with Steve).
• Sample workflow for LP digitization: If and when an improved Sound-Finder/Silence-Finder gets implemented consider adding advice about sound/silence finder as a way to place labels. Peter 19Jul13: Steve is currently working on a new Analyzer with a working title of Album Track Marker.
  • Peter 22Aug13: Moved to placeholder section as Album Track Marker will not be in 2.0.4/2.0.5/2.0.6 (as discussed with Steve).
• Effect Menu: ambiguous, or probably incorrect, Windows tip on when exporting VST presets - commented out in ednote for now

Permanent P1's completed

None