Plan for P1/P2 clean-up

From Audacity Development Manual
Revision as of 09:27, 24 June 2015 by PeterSampson (talk | contribs) (→‎P2s that may block a release: removed the P2 entry for DC Offset this is not a release blocker - one P2 remains on the page though)
Jump to: navigation, search

Permanent P1's

  • Perform a link check using Xenu or other software.
  • 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.

P1

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: 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
  • Spectral edit shelves: Two incorrect points added by Steve fixed - but Steve still thinks this can be improved

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
  • Edit Chains: documentation for the new Use Preset button.

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.

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:

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

  • 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.
Retrieved from "http://alphamanual.audacityteam.org/m/index.php?title=Plan_for_P1/P2_clean-up&oldid=38101"