Main Page

From Audacity Development Manual
Revision as of 20:14, 1 January 2008 by Windinthew (talk | contribs) (Foundations: Reply to James)
Jump to: navigation, search

Welcome, Audacity manual editors!

This is both the front page of the online manual, and the road map for the printed manual. The printed manual is assembled by concatenating all of the articles found on this page, in this order. Anything which is not directly linked from this page will not go in the printed manual.

Links to another page, like [[File Menu]], become page references in the PDF, e.g. File Menu (Page 73).

External hyperlinks, like [http://example.com Example Website], appear in the text as Example Website1 with a footnote containing the URL.

Please read Editing Help to learn about wiki text formatting.

To update the PDF file, see the Export page.

We should try to be consistent in terms of wording and page layout. Layout issues for some page families are still being discussed. See Consistency for current suggested guidelines.

Images: Please ensure all images have appropriate ALT-text. This should be something that describes the contents of the image in the context of its surrounding text for someone who cannot see it.


Audacity Logo


This manual is a work in progress. It relates to the Beta 1.3.5 program, not 1.2.5/6! Audacity 1.3.5 is the basis for our upcoming 1.4.0 stable release of Audacity.

If you would like a Wiki account so that you can help us to complete it, e-mail James (James_AT_audacityteam_DOT_org)


For ideas on what needs to be done to move the manual forward, see:

essential changes to "Audacity for the Impatient" and essential changes to other Manual pages. Also visit the ToDo page.


None of these 'Download The Manual' links yet work properly. For now use this wiki. We'll get these other links working later.

Download the manual as a zip file

Alternate: Download the manual as a PDF file

Alternate: Download the manual as an RTF file (works great in Microsoft Word)

I've given the zip the most prominence, since this is what most people will need to access help from within Audacity.


Audacity 1.3.5 User Manual

Printed Manual Only

The following links will not be visible to users browsing the manual online.

Online Manual Only

The following links will not be included in the printed manual. You can do this with any text by wrapping it in <div class="noexport"> html tags.

On the way out entirely

These also only available on-line.

Tutorials

This manual has two main parts to it:

  • A step by step guide. Organised by tasks (the Tutorials and the Using Audacity sections).
  • A reference section. Organised by GUI structure.

The reference section should be naming the parts of the GUI and saying in outline what they do.

Follow links from Special:Lonelypages and Old Pages to find remnants of the old manual.

The reference section needs to be complete for 1.4.0. I think it's OK if we don't finish all the tutorials, and drop the ones which are incomplete from the html help. JC

Using Audacity

Foundations

One potentially valuable "foundation" we actually don't have is "Audacity Projects" (dealing with the Saving and Exporting confusion).... File Formats in the reference (renamed to Audio File Formats) can then merely div note a reference to the Foundations article (so again, it's in their face that audio files are *not* the same as Project files). Should we be more attention-grabbing so people read that article? "What is an Audacity Project"?... - Gale
I've moved things around a bit to make What is an Audacity Project? a reality, but it's still in an almighty mess at the moment. Can't see the way forward clearly yet.--James
I've had a quick glance at it - thanks. Actually I am not very worried about this at the moment. We link to it in appropriate places in the reference and it may or may not require a separate more technical appendix about it as per the current Audacity Project Format. On current content, I don't think a separate page is justified. A placeholder for .aup has been added to Glossary. I think "What is an Audacity Project?" could be a step by step tutorial with images if we have time, through from import, saving a Project a few times then exporting. I don't think that's essential, maybe only that we state that as an example scenario. As moving Audacity Projects under Foundations was my idea, maybe let me work on Audacity Projects and see what I come up with based on the content you've dropped in there - though I'm not necessarily going to do it immediately .
Unused section now:

Modifying Audio

Other Features of Audacity

  • Recovery is a must and there should be advice on what to do if recovery fails (given it really isn't 100% reliable).
  • Accessibility - Should include the JAWS guide (ready now). Shortcuts must be described (a major job, or are you suggesting not doing that for release?). We can write a short paragraph linking to Audacity Tracks and Clips, the Selection Bar etc. What else is needed that should hold this up in your opinion? - Thanks, Gale


Wanted Topics

The Wanted Topics are in a 'noexport' section. Suggest we don't start writing them yet. They're not essential for 1.4.0.
  • Spectrogram Analysis (or one or more better titles, cover tracking down clicks, square wave as-a-spectrum, beat frequencies).

Reference

Menu Bar:


Toolbars:

Project Window:

Preferences:

File Formats

How about we lose this section entirely? Pages like MP3 format become MP3 Options and live under File Export Dialog in the reference section. MP3 Options loses the text telling you what MP3 format is (it is already there in File Export Dialog). All the text that was in File Formats describing what MP2 format, FLAC format is move into the glossary, perhaps as a separate table there for file formats?--James
I've been thinking much the same - my main concern was what to usefully say on the File Formats page that does not duplicate what is on File Export Dialog. I believe some explanation at least as detailed as currently there is needed to help users make a choice of which format to use. I don't expect we need to link to each format options page on the main page, but maybe note the formats supported alongside the link to File Export Dialog. Don't know yet if we need an appendix for Audio File Formats or can say it in the glossary. My feeling is the glossary should not have a separate section for file formats as we already have (and probably need) generic entries for lossy/lossless and compressed / uncompressed audio format. Audio CDs may possibly still need its own section somewhere (as well as having an entry in Glossary) as of course burning CDs is functionality quite a few users look for in Audacity and wonder where it is. These are relatively minor consideration for now though. - Gale

Other


Need help? Visit http://audacityteam.org/forum - please do not email or post personal information as it will be displayed publicly. Many tips, tricks and useful articles can also be found on our user-editable Wiki - http://audacityteam.org/wiki/index.php?title=Audacity_Wiki_Home_Page

Unless otherwise noted, all pages on this site are available under the terms of the Creative Commons Attribution 3.0 license.