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://github.com/audacity/audacity.

• Check the FAQ! There are almost always things there too that need changing for the next release.

• 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

• Spectrograms Preferences: will need updating with Paul's updates to this dialog.
  • Peter 31Aug15: I have made the draft updates for 2.1.2 - but it needs serious editing from a DSP expert
• Audio Tracks: If Paul's new scroll wheel magnification for Vertical Scale persists, this will require documenting here.
  • Peter 30Aug15: The scroll wheel action now appears to be changed to scrolling the waveform up and down.
• Audio Track Dropdown Menu: Paul's new menu structure requires documenting here once it has stabilized. This may turn out to be quite a big piece of work.
  • Peter 31Aug15: WIP: I made a start on this today and then remembered that the TCP menu is now different for stereo and mono tracks - I need to ponder how we might handle that. Also to be pondered is how much we say here about the various Spectrogram views.
• Spectrogram View: The new Mel. Bark, ERMS and 1/f scaling need to be described here.
  • Peter 31Aug15: Possibly not. They are now described in Spectrograms Preferences so maybe we just need a reference and a link to there from here.

All the above relate to Paul's changes which are still in flux and cannot be tackled yet until the GUI stabilizes.

• MediaWiki:Sidebar: include the Useful External Links portlet in the sidebar here and remove it from the source code, so that Manual editors control it.
  • Peter 27Aug15: I added the portlet to the MediaWiki:Sidebar - but cannot remove it from the source code.

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.
• Spectral Selection: detail that needs sorting

P2 proofread/review needed

See Pages that link to "ToDo-2R"

• Languages: Audacity language can now be chosen in the Windows installer
• Edit Chains: documentation for the new Use Preset button.
• 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
• Effect Menu - Audio Unit Export and Import: Bill 25Jun2015: documentation of audio unit export/import is now accurate (afaict). I've not yet had confirmation from other Mac users.
• Index of Effects, Generators and Analyzers: new entries added to the table need hover-texts adding
• Tutorial - Vocal Removal and Isolation: Tutorial updated for the new Vocal Reduction and Isolation effect.
• Help Menu: Generate Support Data... implemented Gale's suggested additional text
• Index of Effects, Generators and Analyzers Table updated to add back in the legacy Vocal Remover
• Exporting to an External Program fixed the P1 for "The image and text in the first section needs changing."

Placeholders

General Placeholders

See Pages that link to "ToDo-2P"

Placeholder for WDM-KS

WDM-KS is definitely turned off for 2.1.0 and 2.1.1

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

• Edit Menu: Select: will need updating as Paul has removed the special Spectral Selection views.
  • Peter 27Aug15: No changes were actually required - removed the P1
• Spectrogram View: will need updating as Paul if we retain Paul's reversion to "Spectrum" from "Spectrogram". And updating for Paul's new TCP menu in 2.1.2
• Spectral Selection Toolbar: will need updating as Paul if we retain Paul's reversion to "Spectrum" from "Spectrogram".
  • Peter 15Aug15: For now we have reverted to Spectrogram - and this looks likely to stick.
• Spectral edit shelves: will need updating as Paul has removed the special Spectral Selection views.
• Spectrograms Preferences: will need updating as Paul has removed the special Spectral Selection views
• Preferences: ordering will need to change and a new prefs for "Waveforms" added as per Paul's changes.
  • Peter 27Aug15: Paul has removed the new "Waveforms Preferences"
• Effect Menu: Spectral edit multi-tool will need updating as Paul has removed the special Spectral Selection views.
• Spectral Selection: will need updating as Paul has removed the special Spectral Selection views.
• Tutorial - Vocal Removal and Isolation: Gale This is outdated now and needs re-reading for the new Vocal Reduction and Isolation effect. I made a few changes including linking to the released Bass to Center effect instead of ellipticeq.ny.
  • Peter 27Aug15: Made some further updates to this today to make it fit with the VR&I effect
• Preferences: Every Preferences page in the Manual will require updating: image needs to change and so do the imagemaps as per Paul's changes of reordering and adding to the Preferences. This is likely to be a fair bit of work as it involves 18-19 pages.