Main Page

From Audacity Development Manual
Revision as of 18:07, 6 November 2009 by Billw58 (talk | contribs) (reformat About Audacity TOC)
Jump to: navigation, search

Welcome, Audacity manual editors!

Gale: Logged out seeing "For Editors" finally fixed.

Bill: Another thing that is confusing is that the page renders differently when I'm editing and hit 'Show Preview' than when I'm just viewing the page logged in.

Gale: I think that issue is in the software.

Bill: That issue is fixed now, as well. Seems it all had to do with the editsection div!

Gale: It's still not quite right even though I've worked on it. I may just replace it with another div that does the same thing.


This is both the front page of the online manual, and of the local/zipped manual. Anything which is not directly or indirectly linked from this page (is a link on a page that is linked from this page) will not appear in the local/zipped manual. Image pages will not appear in the local/zipped manual, nor will pages outside the manual/audacityteam.org/ domain.

In a previous script (currently broken/out-of-use), the printed manual was assembled by concatenating all of the articles found on this page, in this order. Links to another page, like [[File Menu]], became page references in the PDF, e.g. File Menu (Page 73). External hyperlinks, like [http://example.com Example Website], appeared in the text as Example Website1 with a footnote containing the URL. We used <div class="nochapternumber"></div> at the top of an article if it was an introductory chapter in the printed manual (Copyright, Appendix, etc.). The printed manual was updated on the Export page.

  • Put <div class="noexport"></div> or <div class="editornote"></div> around text or a page to exclude it from the local/zipped and printed manual.
  • Put <div class="note"></div> around text for text inside a box. This appears in all versions of the manual.

Please read Editing Help to learn about wiki text formatting.

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.9 program, not 1.2.5/6! Audacity 1.3.9 is the basis for our upcoming 2.0 stable release of Audacity.

There are no translations of this Manual to other languages yet. Try here for help in other languages.

Can you help us complete the Manual, or translate it to other languages? If so, please 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.


The Audacity Manual (current at time of release) is included in version 1.3.9 if you obtain the Windows .exe or Mac OS X .dmg Audacity installers.

To view the Manual, click Help > Manual (in web browser), or Help > Quick Help (in web browser) to access the "Getting Started" section of the manual. This will load the local Manual files in your web browser, without the need for an internet connection.

If you have obtained the zip version of Audacity or are on Linux, you can download the same Manual here. Instructions are here.


Audacity 1.3.9 User Manual

Printed Manual Only

The following links will not be visible to logged-out online or in the dumped (installed) manual:


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 logged-out online/installed manual. They can still be found online through Search):

About this Manual

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

  • Audacity for the Impatient Schematic diagram of Audacity with quick links to the main parts of the interface.
  • Getting Started Quick help to get you recording, importing files, editing and exporting your work in no time.

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 2.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 .
Bill: A small point, perhaps, but I think a more logical ordering of these items would be: Digital Audio / What is an Audacity Project / Audacity Setup and Configuration / Playing and Recording / Audacity Selection / Audacity Tracks and Clips / Zooming / Undo Redo and History. If only for the the convenience of the reader who takes the time to read this entire section - they'd start with the basics to digital audio, then find out about Audacity Projects, how to set up Audacity, and finally how to use Audacity.

Help with Advanced Issues

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


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, Repair

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




Links: Most links are to other pages in this Manual. Bold italicized  links are to a description in our Glossary. Other italicised  links are to pages external to this Manual, for whose content we are not responsible.

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

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.