Plan for P1/P2 clean-up

From Audacity Development Manual
Revision as of 10:46, 22 January 2016 by PeterSampson (talk | contribs) (P2R cruft removal)
Jump to: navigation, search

Permanent P1's

  • Perform a link check using Xenu or other software.
    • Peter 04Nov15: I've started work on this and fixed several - but it's a long hard slog
    • Peter 05Nov15: I've had a long trawl through the Xenu report and found an fixed about 18 bad/broken links. There are many many more that relate to translated pages, user pages and talk pages, I have no plans to touch those.
  • 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).


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

  • 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.
  • Update the Wikipedia page

P1

None known

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.

P2 proofread/review needed

See Pages that link to "ToDo-2R"


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:

Wiki P2s re WDM-KS

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

P2 placeholders for VST presets Mac bug

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

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 was a fair bit of work as it involves 18-19 pages.
  • Spectrogram View: References to "Spectrogram log(f)" changed to Logarithmic.
  • Spectrogram View: If Paul's color change for spectrograms persist for 2.1.2 then the only the last image on this page will need to be updated
  • 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.
  • Noise Reduction: Image needs updating for new default settings ("smoothing" = 6)
  • Spectral Selection: If Paul's color change for spectrograms persist for 2.1.2 then the images on this page will need to be updated - this will be a big piece of work
    • Peter 03Sep15: downgraded the P1 to a P2 on the basis of having incorporated James' suggested color-neutral wording
      • Peter 12Sep15: Images all updated by Bill on 11Sep15
  • Manage changed to Add / Remove Plug-ins: Peter 13Sep15 - due to a recent interest I've developed in plug-ins I found (and corrected) a whole slew of uses of Manage... which should have been found and changed to Add / Remove Plug-ins... I think I find them all, but d please keep your eyes open for any I may have missed
  • 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.
  • Spectrogram View: The new Mel. Bark, ERMS and Period scaling need to be described here.
    • Peter 03Sep15: these are now described - but we could probably do with some images and examples of usage of these new spectrogram scales.
  • Audio Track Dropdown Menu the dropdown menu image needs updating - we did this to deal with Bug #1250
    • Peter 04Nov15: Done
  • Accessibility: point out that 2.1.2 is NOT accessible on Mac and point users to the agreed replacement version
    • Gale 07Nov15: David added a link to the 2.1.1-vi version, so I removed the P1.
  • Tutorial - Recording Computer Playback on Mac: Soundflower 1.66b will not work in El Capitan so instructions for installing Soundflower 2.0b2 will be needed
  • Gale 06Dec15: Spectral Selection: Multi-tool description confused 0 Hz with undefined.
  • Directories Preferences image requires updating as the default workfile directory has changed with r0629c31
  • Directories Preferences Gale clarified that the temp dir changes in r0629c31 only affect Windows and stated that the image shown is only for Windows Vista and later. The temp dirs for all OS'es are listed at Recovering crashes manually.
Retrieved from "http://alphamanual.audacityteam.org/m/index.php?title=Plan_for_P1/P2_clean-up&oldid=39781"