Plan for P1/P2 clean-up

From Audacity Development Manual
Revision as of 09:12, 30 August 2016 by PeterSampson (talk | contribs) (* Audio Tracks Mouse behaviour in vertical scale changed - moved to Completed section)
Jump to: navigation, search

Permanent P1's

  • Perform a link check using Xenu or other software.
  • 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
    • Peter 22Jan16:Updated for 2.1.2

P1

Wiki P1s

  • Audacity Comparisons - looks to be well out of date and needs a good refresh if we intend to keeep it. It's almost an orphan anyway it's only really linked to by Comparative Analysis and that in its turn is only linked to from James' user page.
  • Compiling Audacity for Beginners Steve thinks this page should be removed, Gale wants to keep it for links from the Forum - if we keep it it needs updating
  • Mac OS X Gale wrote: As it stands, this page is actually very useful for users of legacy Audacity on Mac OS X, but needs a complete rewrite for current Audacity.
  • Developing On Windows Some removal of legacy historical context is needed here. Has been updated for move to VS2013 by means of advice div at top. This page needs more work or trimming just to the advice, probably
  • Windows 7 OS advice about using WASAPI to make a silent recording needs tweaking as some machines on 2.1.0 may no longer be able to record silently using that method.
  • Nyquist Plug-ins Reference image required for numeric text widget
  • Proposal Noise Removal The Noise Reduction effect replaced Noise Removal in 2.1.0.
  • Notes For Testers this page is way out of date and requires refreshing
  • FFmpeg integration With the "recommended" FFmpeg 2-2-2 the table is well outdated. Probably we should mention important formats that are supported in recommended 2.2.2 such as Opus, Speex encoding, AMR WB encoding (Windows).

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, 2.1.1, 2.1.2 and probably for 2.1.3. It may never be turned back on again.

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

  • Index of Effects, Generators and Analyzers Table updated for new Distortion effect and removed the superseded Leveller effect.
  • Warnings Preferences: PreferencesWarningsLowDiskSpace win10.png image restored.
  • 2.1.3 will officially support Windows 10 so references to specific Windows versions will need updating, or changed to a generic "Windows Vista and later". Windows 10 is supposed to be the last version of Windows, perpetually updated, so we may want to be specific. It makes things easier for users new to computers who may not know Windows version history.
    • Peter 11Apr16: I've had a good comb through this morning and made what I think are all the necessary changes . In some cases I used "Vista or later" in many others I was explicit. If and when we eventually stop supporting Windows XP we can tidy up the Manual considerably.
    • Peter 12Apr16: And today I did a similar trawl in the Wiki fixing that up for Windows 10
  • Bass and Treble The image and text will need updating as Steve has improved this effect.
  • Transport Toolbar needs updating for Steve's new Append Record button
  • Timer Record Requires updating for dialog images that have been corrected for or standard capitalization.
  • Warnings Preferences the options here have changed. The image and the page need updating.
  • Effect Menu Steve's new Distortion effect needs to be documented and added to this page.
  • Index of Effects, Generators and Analyzers Steve's new Distortion effect needs to be documented and added to this page.
  • Time Tracks images need updating - most are P2s but there is one P1
  • Edit Chains nedds an update image now that Leveller has been removed and Distortion added
  • Contrast Steve's fix for Bug #1361 may, "change the appearance of the time controls just a little". This needs to be checked and the image updated if that is indeed the case.
  • Distortion currently only a semi-skeletal page - now completed
  • Scrubbing and Seeking This page will require a major update for the revised GUI - not to be updated until Paul's GUI changes stabilize and finalize - and for pinned play/record head
  • Playing and Recording Scrubbing and Seeking section will require a major update for the revised GUI - not to be updated until Paul's GUI changes stabilize and finalize.
  • Tracks Preferences scrolling left of zero section needs updating
  • Timeline needs updating as we now have the pinned play/record head button at the left in the Timeline
  • Navigation Tips need to mention scrubbing
  • Playback Preferences Paul has added "Pinned playback/recording head" - not to be updated until his GUI changes stabilize and finalize.
  • Status Bar messages have changed - text and images need updating
  • Tracks Preferences & Playback Preferences pinned playhead option moved
  • Front page Now that we have Paul's new Scrub Toolbar we must of necessity update the amazing-imagemap.
  • Audio Tracks Mouse behaviour in vertical scale changed
Retrieved from "http://alphamanual.audacityteam.org/m/index.php?title=Plan_for_P1/P2_clean-up&oldid=42205"