Re: thoughts on grammar

2 messages Options
Embed this post
Permalink
Ed Musgrove-2

Re: thoughts on grammar

Reply Threaded More More options
Print post
Permalink
http://manual.audacityteam.org/index.php?title=Main_Page

Just so folks can get an idea of my thoughts on grammar and consistency, I
would make the following changes (and will do so if I can figure out how and
nobody complains!):

About one third of the way down is something that looks vaguely like this
(the asterisks are green squares and nothing is indented; I have indicated
links by surrounding them with an underscore: _link_):
______________________________________________________________________
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:

*_Tutorials_ - walk through various common tasks in more detail
*_Using Audacity_ - contains
*_Foundations_ (fundamental concepts of digital audio and editing in
Audacity) and Help with Advanced Issues (read the ones that apply to you as
required)
*_Reference_ - explains every button, tool, menu item and dialog in Audacity

*_Miscellaneous_ - includes an _Index_, _Glossary_ of technical terms used
in the Manual, _Frequently Asked Questions_ and _License_
-------------------------------------------------------------------
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:

*_Tutorials_ - walk through various common tasks in more detail.
*_Using Audacity_ - contains:
     *_Foundations_ - fundamental concepts of digital audio and editing in
Audacity and _Help with Advanced Issues_.
     *_Reference_ - explains every button, tool, menu item and dialog in
Audacity.
     *_Miscellaneous_ - includes an _Index_, _Glossary_ of technical terms
used in the Manual, _Frequently Asked Questions_ and _License_.

Note that I've made the first two lines starting with asterisks look more
like the last five lines. Note the consistent use of a colon (:) after
"contains". Note that I have indented (I do not know how to do that on the
wiki) the final three lines.

As an aside, note that when you click on the link "Using Audacity" the
subsection Foundations does not have a line under it (though Reference and
Miscellaneous do) and it has sub-sub sections which are labeled in the same
size font as itself; for consistency it should have a line under it (I
realize that the lines under Reference and Miscellaneous are probably
artifacts) and the sub-sub section titles should be either not bold, a
smaller font or indented.


--Ed



------------------------------------------------------------------------------
Let Crystal Reports handle the reporting - Free Crystal Reports 2008 30-Day
trial. Simplify your report design, integration and deployment - and focus on
what you do best, core application coding. Discover what's new with
Crystal Reports now.  http://p.sf.net/sfu/bobj-july
_______________________________________________
audacity-devel mailing list
[hidden email]
https://lists.sourceforge.net/lists/listinfo/audacity-devel
Bill Wharrie

Re: Manual - thoughts on grammar

Reply Threaded More More options
Print post
Permalink
Ed:
   First, if we're going to talk about this on-list, I suggest we put  
"Manual - " in the subject line so those not working on the manual can  
ignore these threads.

On 6-Nov-09, at 12:30 PM, Ed Musgrove wrote:

> http://manual.audacityteam.org/index.php?title=Main_Page
>
> Just so folks can get an idea of my thoughts on grammar and  
> consistency, I
> would make the following changes (and will do so if I can figure out  
> how and
> nobody complains!):

[snip]

> Note that I've made the first two lines starting with asterisks look  
> more
> like the last five lines. Note the consistent use of a colon (:) after
> "contains". Note that I have indented (I do not know how to do that  
> on the
> wiki) the final three lines.

Asterisks in wiki markup create lists. Double-asterisks create an  
indented sub-list.

>
> As an aside, note that when you click on the link "Using Audacity" the
> subsection Foundations does not have a line under it (though  
> Reference and
> Miscellaneous do) and it has sub-sub sections which are labeled in  
> the same
> size font as itself; for consistency it should have a line under it (I
> realize that the lines under Reference and Miscellaneous are probably
> artifacts) and the sub-sub section titles should be either not bold, a
> smaller font or indented.

h2 markup (==Header==) gets a line. Lower level headings (===Sub-
head===) don't get lines.

We're basically building our own custom table of contents.

The changes you are proposing are small and I've done them. Have a  
look at the code and you'll see how this works.

I've been thinking about doing this and putting it off. Thanks for the  
prod.

-- Bill


------------------------------------------------------------------------------
Let Crystal Reports handle the reporting - Free Crystal Reports 2008 30-Day
trial. Simplify your report design, integration and deployment - and focus on
what you do best, core application coding. Discover what's new with
Crystal Reports now.  http://p.sf.net/sfu/bobj-july
_______________________________________________
audacity-devel mailing list
[hidden email]
https://lists.sourceforge.net/lists/listinfo/audacity-devel