Main Page

From Audacity Development Manual
Revision as of 05:14, 28 January 2008 by DominicMazzoni (talk | contribs)
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 James (James_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

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. There are a lot of pages in the main namespace - see List of Pages - that won't be exported, mainly old material. Have we got to list all those here or div the text on those pages? This seems to contradict "Anything which is not directly linked from this page will not go in the printed manual". Is the "noexport" list here just a convenience to remind ourselves not to put a link to them in the "export" section of the front page?


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

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

Help with Advanced Issues

Is this the best place for "Audio CDs"??


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


Other

"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 favour of Wiki and Forum links)

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

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.