Talk:Main Page

From Audacity Development Manual
Revision as of 20:05, 4 December 2007 by Windinthew (talk | contribs) (Editorial Consistency: maybe numbers without separators is best (less to change, matches Audacity))
Jump to: navigation, search


Editorial Consistency

Can we have some decisions here on:

US or British English (dialog/dialogue etc.) - as the program is in US English and possibly its audience is more on the American continent than the European, it probably has to be US English.

Numbers - I was trained that single digit numbers are in words, else in numbers

"five tracks", not "5 tracks"

and that spaces demarcate thousands , not commas

"44 100 Hz", not "44,100 Hz" or "44100 Hz"

Possibly "no spaces" is preferred, but (against), this won't work with larger numbers if there are any, and Germans use comma to denote a decimal space.

My vote is "44 100 Hz" and "five tracks" unless contradicted here.

Gale

US English. Yes. (behavior, color, realize...)

I'm used to 44,100 Hz, and expect Audacity to use a ',' as a separator (when language=en) when it is being nice in that regard, but can live with 44 100 Hz in this text. The low-number rule is fine too.

--James

Thanks. I am easy about thousand separators or not, and am coming to the conclusion that as most of the manual seems to be already written without separators, and this matches Audacity, perhaps no separators is best and work round any million or greater numbers that may be lurking.

Gale

Structure

Audacity Selection and Selecting are similar pages both linked to from the Main page. Is this overlap what we want? (probably yes, but just checking). JamesCrook 15:23, 24 November 2007 (PST)

Looks a bit odd to me. I'd say either make two paragraphs saying that Audacity depends on selections of audio and that it works on the basis of Tracks and Clips, or (better) delete Audacity Selection and Audacity Tracks and Clips altogether and use the Selecting and Tracks and Clips articles in the "Using Audacity" section. In either case the article to do with selection probably needs a quick note of the select all on none feature that is on by default.


On the Tools Toolbar page I've linked the individual tools to the comprehensive articles on the topic - e.g. for envelopes and for selecting. Should we do the same for the links on the main page rather than create new short pages for these tools? JamesCrook 15:23, 24 November 2007 (PST)

I can certainly see the top of Playing and Recording is a duplication of Control Toolbar. We certainly don't want that duplication.


There's at least three styles of writing in this manual.

  • There's the remnants of the old reference manual- not linked to directly from the main page, but still visible via the FAQ.
  • There's the detailed tutorial style of the main help.
  • There's some newer reference help that is brief.

I'm thinking the reference section needs to stay brief, so that anyone can quickly see what the features are by reading the reference section. To understand how to use the features they'll either start in the tutorial sections, or get to the tutorials from links from the reference section. The old reference material is gradually deprecated as we replace it with newer stuff. Sound OK? JamesCrook 16:31, 24 November 2007 (PST)

Reference section looks quite verbose to me in places e.g. the Effects section in the Reference is longer than Applying Effects in "Using Audacity" and there is quite a bit of duplication. Splitting Stereo Tracks has no corresponding section for the Track Popdown Menu in Reference? Editing: Cut, Paste, and More in "Using Audacity" looks like a duplication of Edit in the Reference. I think this needs a serious rethink and I don't think the Reference section in many cases can even be useful unless it describes all the menus and Preferences properly (and non-geekishly). I'm beginning to wonder if we need more (or longer?) "Tutorials" - something along the lines of the sections of "Using Audacity" but integrated into a real life scenario. For example there might be "my first session editing an audio file" and so this includes importing, editing and export/save (but split sufficiently that sections can be accessed individually or returned to). Then instead of "Using Audacity", a proper "How do I ..." index (links only, no descriptions) that people can go to for how to do an exact thing. Examples of this would be "recording..//choose mono or stereo recording" (goes to Reference: Audio I/O tab of Preferences) "create a new track" (goes to Reference:Tracks Menu).... "recording..// adjust input levels" (goes to Tutorial:My first recording).


Gale