Plan for P1/P2 clean-up

From Audacity Development Manual
Revision as of 10:41, 13 January 2015 by PeterSampson (talk | contribs) (moved many of the Noise Reduction sub-tasks to the Completed section - the page itself remains P1 as editing is still required)
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).

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

  • Main Page the imagemap will require updating for the toolbars that have changed in 2.1.0: Meters, Device, Mixer - the tooldock layout has changed too.
  • Spectral Selection in progress. May need spin-off tutorial pages. Mouse Preferences, Status Bar, Effect Menu and Index of Effects, Generators and Analyzers also need modifying.
  • Preferences Add Modules Preferences to the list of Prefs. Replace all the images (Modules Prefs image already replaced)
    • Peter 06Oct14: Has Modules Prefs been fully turned on - or is it just loaded as "experimental" for testing? I.e. how likely is it to remain a feature for 2.0.7 release?
    • Gale 07Oct14: It has been defined in Experimental.h so if that does not change it will be released.
      • Peter 07Oct14: In which case I am inclined to leave working on this until later in the release cycle (as I do not want to have to unpick all this yet again if we decide not to retain it). As it is, when I unwound it last time I left copies on the various Prefs pages of the necessary stuff for the imagemaps (saved on the Talk pages) and we can easily revert to the prior images. Thoughts?
      • Gale 08Oct14: Thanks for saving the image map data. I think we can leave this for the immediate future, as you suggest.
    • Peter 13Jan15: It's looking like, if I read Vaughan's RM email comments correctly that Modules will not be in 2.1.0.
  • Modules Preferences Update the page.
    • Peter 06Oct14: I was going to start work on this - but when I go to the Prefs>Modules page all I get is the dialog box with "No modules were found" available in the dropdown list. Is that it?
    • Gale 07Oct14: Most users will not have any modules, so that is how the topmost image in the Modules Prefs page should appear in the Manual (except we are waiting for James to add text about the need to restart). Users who install current Audacity over previous versions where mod-script-pipe was shipped will see mod-script-pipe in Modules Prefs as "New", so that case ought to be documented. Note that if they "enable" that old mod-script-pipe in Modules Prefs, Audacity won't launch any longer, which will have to be fixed.

      The meaning of each choice in Modules Prefs will have to be documented so only someone who can build a module the same day as building Audacity can fully document it. So either Steve or I will have to document this page.

    • Peter 13Jan15: It's looking like, if I read Vaughan's RM email comments correctly that Modules will not be in 2.1.0.
  • Nyquist Prompt: An experimental "Nyquist Workbench" graphical editor module is available if you compile the module and Audacity from source code, then enable the module in Modules Preferences.
    • Peter 13Jan15: It's looking like, if I read Vaughan's RM email comments correctly that Modules will not be in 2.1.0.
  • Index of Effects, Generators and Analyzers the Cross Fade Out entry still needs removing from the table (left for Gale)
  • Transport Toolbar needs updating with the new Play Cut Preview and Append record button functionality
  • Noise Reduction to be written
  • Real Time Preview
    • SC4: needs a new image and description since this effect is now real-time preview capable.
      • Peter 15Dec14: added new 2.1.0 RTP image - text description of RTP controls still required* The new Noise Reduction effect will be replacing Noise Removal in 2.1.0 and the Noise Removal effect will be "retired". This is looing like a fair amount of work. Pages affected:
    • Noise Reduction to be written
      • Written, but editing still in progress
    • Noise Removal page to be "retired" - care to be taken with links.
      • Content has been "retired" left a ghost landing page to redirect readers (from external links - mainly Forum) to the new page
    • Effect Menu requires updating
      • Done
    • Index of Effects, Generators and Analyzers requires updating
      • Done
    • Several other pages have links to Noise Removal that need to be changed to Noise Reduction - some of these have text that will need potential tweaking to reflect the removal=>reduction change.
      • Done
    • Hard Limiter: needs a new image and description since this effect is now real-time preview capable.
      • Peter 15Dec14: added new 2.1.0 RTP image - text description of RTP controls still required

New Hosts

Not yet listed as P1s, as there remains the issue of whether or not:

  • WDM-KS will remain in the 2.1.0 release
  • WASAPI full functionality retained - or reversion to loopback only

The following pages currently have P2s associated with WDM-KS / WASAPI that may become P1s:

Wiki P2s re WDM-KS

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

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.
  • DC offset: need to discuss naturally occurring offset recordings


P2 placeholders for VST Linux support when re-enabled

P2 placeholders for VST presets Mac bug

P2 placeholder for Audacity compilation on Linux against FFmpeg

Items completed subject to review

  • Meter Toolbar Transition band and Meter Preferences changes. Click the playback meter to reset the peak level indicator instead of having to click the record meter.
    • Peter 04Oct14: I have this on my personal action list, once the dust has settled on the GUI.
    • Peter 09Oct14: As Leland informed us that no further changes will be made for now I went ahead and added documentation for the new Gradient Meters.

Placeholders

  • 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.
  • 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).

Permanent P1's completed

Completed items

  • Gale: New images made for the Preview button added to Nyquist Prompt, clipfix, delay, highpass, lowpass, notch, tremolo, vocalremover and vocoder effects. Text changes made. Adjustable Fade does not have a Preview button because the effect changes over time and Preview only works on the preview length.
  • RMS not rms, including Contrast image updated for "RMS".
  • Device Toolbar, Mixer Toolbar and Meter Toolbar have recording before playback. New images needed, probably a number of images involved for Meter Toolbar, and text should be checked as well for instances of "right-hand" and "left-hand".
Retrieved from "http://alphamanual.audacityteam.org/m/index.php?title=Plan_for_P1/P2_clean-up&oldid=34931"