Main Page

From Audacity Development Manual
Revision as of 06:29, 29 June 2008 by Windinthew (talk | contribs) (link to temporary instructions for downloading Help and displaying in Audacity)
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.

Put <div class="nochapternumber"></div> at the top of an article if it's an introductory chapter in the printed manual (Copyright, Appendix, etc.)

Put <div class="noexport"></div> tags around a section you want to not appear in the printed manual.

Put <div class="editornote"></div> around text for a box like this one, also not to appear in the printed manual.

Put <div class="note"></div> around text for text inside a box, both online and in the printed manual.

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 Gale (gale_AT_audacityteam_DOT_org)


For ideas on what needs to be done to
move the manual forward, see the ToDo page.


Download the manual as a zip file


1.3 Manuals can be downloaded for standalone reading in PDF or RTF format. RTF can be opened in Microsoft Word.
It is possible to obtain a one page version of the HTML manual, and view it in the help browser in Audacity 1.3.5. Please note that due to significant problem with our HTML export script, many of the internal links in the document don't work. It is also possible to obtain a fully functional but much more out-of-date help file for display in Audacity. This includes most of the features that 1.3.2 had when it was current. Go to the instructions.

Audacity 1.3.5 User Manual

Printed Manual Only

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

Excluded from printed and online Manual

The following old/experimental pages will be excluded from both the printed manual and from the front page of the online manual (though they can still be found online through Search):

Online only

The "About this Manual" section is online manual only, and the linked to "Audacity for the Impatient" page is also only available online. To prevent the export of specific text inside pages that are being exported, wrap it in <div class="noexport"> html tags.

About this Manual

The Manual is divided into several sections. If you're in a hurry, try:

Otherwise, the Manual contains:

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

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


Tutorials


Using Audacity

Foundations

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 .

Help with Advanced Issues

Is this the best place for "Audio CDs"??
Should include the JAWS guide (ready now). Write a short paragraph linking to Audacity Tracks and Clips, the Selection Bar etc.

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: all commands for importing, recording,
manipulating and exporting audio

WAV, AIFF and uncompressed types, MP3*, Ogg Vorbis, FLAC, MP2 and Command line export   *MP3 export requires the LAME MP3 encoder
  • Detailed help for some of the more complex built-in effects:
Auto Duck, Compressor, Equalization, Noise Removal


Toolbars: buttons and controls for playback,
recording and editing

  • Extra help with Envelope Tool for controlling amplitude changes smoothly, and Multi-Tool (combining all tools in one)


Project Window:


Preferences:

File Formats section now removed. Pages like MP3 format are now MP3 Export Options and are parked under File Export Dialog in the reference section. MP3 Export Options and similar lose their text telling you what MP3 format is (it is already there in File Export Dialog). A basic description of each format will be in Glossary. We may or may not have extra text for the formats as a "File extensions" appendix including the current content of Audacity Project Format. If we get the level of text right in File Export Dialog and link to the Glossary with links to Wikipedia or our Wiki this might not be needed, except that it's still handy for people importing these formats. - Gale

Miscellaneous

Index, Glossary and Frequently Asked Questions:

Credits, License and Further Information:

"Audacity Project Format" parked here in case we have an appendix for "file format extensions" - I'm currently unsure - Gale .
The Audacity project file structure should, I think, be given good prominence - not just parked down here. The reason I say this is because a lot of queries of the forum clearly arise because users have no idea about the Audacity project structure. - Peter
I agree the project structure is critical which is why we created What is an Audacity Project and put it under "Foundations". See the discussion near the top of the main page. This section at the bottom is possibly a more technical description of the project format which might go in a File Formats appendix to include mainly audio file formats (if we feel we need to say more about those than we do elsewhere). - Gale

Further help if you need it (preferably expand and complete this page or delete it in favor of Wiki and Forum links)

Copyright: Unless otherwise noted, all pages on this site are available under the terms of the Creative Commons Attribution 3.0 license. In essence, you are free to (1) copy, distribute and transmit the work (2) to adapt the work, under condition you must attribute the work to the authors (but not in any way that suggests that they endorse you or your use of the work). For any reuse or distribution, you must make clear to others the license terms of this work. Any of the above conditions can be waived if you get permission from us.

Links: Most links are to other pages in this Manual. Bold italicized  links are to a description in our Glossary. Links with an appended External.png symbol are to pages external to this Manual.

Unless otherwise noted in the hover text of the image, all screenshots of Audacity in the Manual are of Microsoft Windows operating systems.