Plan for P1/P2 clean-up

From Audacity Development Manual
Revision as of 11:00, 11 February 2015 by PeterSampson (talk | contribs) (moved ToDo - Plan for P1/P2 clean-up for 2.1.0 to Plan for P1/P2 clean-up: make it version neutral)
Jump to: navigation, search

Permanent P1's

  • Perform a link check using Xenu or other software.
    • Peter 10Feb15: Running a Xenu check right now - I've found and crushed a few dead links, it's an arduous process as the vast majority of the reporting duff links relate to translated pages
  • 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

  • Effects Preferences: 64-bit Linux VST question still remains
    • Peter 10Feb15: This may really only be a P2?
    • Steve commented by email 10Feb15: "Leland says that 64 bit plugins work on 64 bit builds of Audacity on Linux. I don't have a 64 bit OS so I can't test that, but I assume that Leland is (correct unless we hear otherwise)."
    • Gale 10Feb15: Users on 64-bit Linux will care about it. I have 64-bit Ubuntu so I can test it.
  • Effect Menu: No description that output controls are supported where available for LADSPA effects.
    • Peter 11Feb15: Neither Steve nor I have the foggiest idea what this means - and I really don't see this as a P1 release blocker.
  • WASAPI - it appears that full WASAPI is likely to remain in 2.1.0, accordingly the following pages will need updating:

Noise Reduction/Removal P1 in the Wiki

The following Wiki pages will also need attention regarding the new Noise Reduction but the final work can only be undertaken once 2.1.0 is released - as the Wiki always relates to the current version. The preparatory groundwork has been laid to prepare for this task.

  • New page Noise Reduction created - but it needs some serious editing
  • Old page Noise Removal must remain in Wiki until 2.1.0 is released, then it can become a landing page
  • New page How Noise Reduction Works created - but it needs some serious editing
    • Peter 29Aug14: Done: Paul Licameli has edited the page to bring it up to date with the new technology
  • Old page How Noise Removal Works must remain in Wiki until 2.1.0 is released, then it can become a landing page
  • and probably Proposal Noise Removal

New Hosts

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

  • WASAPI full functionality retained - or reversion to loopback only

WDM-KS is definitely turned off for 2.1.0

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.
    • Peter 04Feb14: we have carried this issue through several releases, since December 2011. It has never been a blocker previously.
  • DC offset: need to discuss naturally occurring offset recordings
    • Peter 29Jan15This has been an ongoing unresolved ednote discussion since late 2012
  • Transport Toolbar: needs the new "Append Record" icon and the new "Play Cut Preview" icon documenting.
    • Peter 29Jan15: I have documented these (thus downgrading the P1 to P2) but with full button images. I have no idea how to create the naked button icon images that are required for consistency with the rest of the page.

P2 proofread/review needed

  • Noise Reduction much editing is still required
  • Spectral edit multi tool
  • Digital Audio
  • Tutorial - Making Ringtones
  • Spectrogram View: an image showing spectral selection
  • Spectral Selection Gales changes in the "Spectral edit shelves" section
  • FAQ:Installation_and_Plug-Ins#vst_install and FAQ:Installation_and_Plug-Ins#linux_plugins updated for re-enabling of VST support on Linux
  • Effect Menu updated for re-enabling of VST support on Linux
    • Peter 11Feb15: afaict Gale made the necessary update with the Linux VST pathing that Leland provided
  • Keyboard Shortcut Reference: Spectral selection bindings
    • Peter 10Feb15: I have added the only spectral selection that shows up on my latest alpha vn. which is : Select > Spectral > Toggle Spectral Selection with it's shortcut "Q" - is this then complete or are there others?
    • Gale 10Feb15: That is the only one I know of with a binding but there are at least three others for which user can add a binding - see for example Robert's post on -quality. I'll do this if you are not sure.
    • Peter 11Feb15: I've added the user definable shortcuts for spectral selection - but there are only two of those that show up on my W7 latest alpha - so I don't know where you get "there are at least three others for which user can add a binding" Gale, I'm confused.

Placeholders for Modules

Modules has been turned off for 2.1.0

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

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 behaviour. Probably the behaviour is too buggy and confusing to be documented now, so this is a placeholder for when the behaviour 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 behaviour. Probably the behaviour is too buggy and confusing to be documented now, so this is a placeholder for when the behaviour is bug fixed and better signposted.
    • Peter 29Jan15: Logged as P3 on Bugzilla #825

P2 placeholder for Audacity compilation on Linux against FFmpeg

Items completed subject to review

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).
  • [[Label Tracks]: maybe a mention on this page that Label Tracks can be used to define sets of sync-locked track groups?
  • Effect Menu: ambiguous, or probably incorrect, Windows tip on when exporting VST presets

Permanent P1's completed

Completed items

  • Real-time preview of effects: We need a new image of the "control panel" of a VST effect in graphical mode. We may also want an example of a LADSPA effect in text mode
  • Edit Menu: Select sub-menu omits new spectral selection commands. (was P1)
  • 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".
  • 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 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.
  • Digital Audio Fundamentals: "Sample rates" section needs editing - the whole page should be reviewed
  • Noise Reduction Spectral selection ability removed from Noise Reduction. Gale has already removed the reference to NR on Spectral Selection. Peter removed the spectral advice on the Noise Reduction page.
  • Effects Preferences: New dialog image needed.
  • Audio Track Dropdown Menu: accuracy comment from Steve re purpose of dB view - removed contentious text
  • Hard Limiter: image outdated - now has text buttons.
  • SC4: image outdated - now has text buttons.
  • Spectrogram View: warning in "large, friendly letters" on this page to warn that spectral selection is activated in this view
  • Spectrogram View: image of a normal recording in Spectrogram view
  • SC4: text description of the Effect Output pane
Retrieved from "http://alphamanual.audacityteam.org/m/index.php?title=Plan_for_P1/P2_clean-up&oldid=35677"