Add a tab to the instruction book

This read-only archive contains discussions from the Adding Feature forum.
New feature request may be posted to the Adding Feature forum.
Technical support is available via the Help forum.
Gale Andrews
Quality Assurance
Posts: 41761
Joined: Fri Jul 27, 2007 12:02 am
Operating System: Windows 10

Re: Add a tab to the instruction book

Post by Gale Andrews » Wed Jul 30, 2014 12:35 am

waxcylinder wrote:
Gale Andrews wrote:There is another downside. The syntax is:

Code: Select all

[[Image:Record.png|link=|Record button]]
but that syntax kills the hover text. I've not found a working solution for that.
Yes... I just discovered that - see: http://manual.audacityteam.org/man/Tuto ... cted_audio

Do you want me to revert those link- changes ?
I think it would be better to revert for now.

Consistency says we should apply "link=" to small inline images (where hover text may not matter so much): http://manual.audacityteam.org/man/Cons ... ine_images .

Is that a reasonable distinction, so that (if we get the dump script changed) all but small inline images have hover text and open the image locally (but do not go to the development Manual)?


Gale
________________________________________FOR INSTANT HELP: (Click on Link below)
* * * * * Tips * * * * * Tutorials * * * * * Quick Start Guide * * * * * Audacity Manual

kozikowski
Forum Staff
Posts: 69357
Joined: Thu Aug 02, 2007 5:57 pm
Operating System: macOS 10.13 High Sierra

Re: Add a tab to the instruction book

Post by kozikowski » Wed Jul 30, 2014 1:42 am

By tab do you mean a div? There are no tabs in the released manual and it would be hackage to add them.
OK, Little Green Squares.

My goal is One Stop Shopping.

The manual is getting tantalizingly close. I stopped going to my little notes, bookmarks, post-its and hasty scratches on matchbook covers for most forum questions. The manual is just too fast and convenient.

Until it's not. The problem with slick is that unslick stands out.

This manual and the programs it points to should always be The Current Supported Versions. Alpha, Beta, Temporary Releases, etc, are all behind the scenes stuff and nobody has to involve the user in any of that. Or The Book.

External Links suggest something dark, forbidding, and not entirely associated with Audacity; not a way to access the Audacity program (no prefix or suffix). That's just Links (no modifiers)

But I do want real external links. User supplied software, experimental stuff, "floobydust" I think one company called it.

If that makes you nervous, then links to places where you can look up user-supplied, experimental, etc. If that's a monumental task, then that's the real task. Garden hosing programs, filters, effects, etc over a wide area is not particularly good bookkeeping.

Koz

waxcylinder
Forum Staff
Posts: 14684
Joined: Tue Jul 31, 2007 11:03 am
Operating System: Windows 10

Re: Add a tab to the instruction book

Post by waxcylinder » Wed Jul 30, 2014 10:33 am

kozikowski wrote: My goal is One Stop Shopping.

The manual is getting tantalizingly close. I stopped going to my little notes, bookmarks, post-its and hasty scratches on matchbook covers for most forum questions. The manual is just too fast and convenient.
As an editor of the Manual that is my goal too.

You should find that once 2.0.6 is released the Manual is improved further in this regard - I have been doing a lot of work on the alpha Manual, moving stuff from the Wiki which is Audacity specific and version specific. This should make the Manual more self-contained and avoid us booting the reader over to the Wiki for stuff which is directly about Audacity and Audacity usage. So Tutorials have been expanded and Tips have been moved across, along with many other changes.

kozikowski wrote:Until it's not. The problem with slick is that unslick stands out.
So what is unslick? To answer that question you will need to review the Alpha 2.0.6 Manual: http://manual.audacityteam.org/man/Main_Page

I tried to remove one of your unslicks yesterday by adding a clear link for Audacity downloading to the Manual's Front page. Is that now a slick?

kozikowski wrote:This manual and the programs it points to should always be The Current Supported Versions. Alpha, Beta, Temporary Releases, etc, are all behind the scenes stuff and nobody has to involve the user in any of that. Or The Book.
The Manual is only focused on the current version (only the Alpha manual directs to the alpha downloads - for the bleeding-edge alpha users). The other recent work on the Wiki was to make the content as version-neutral as possible, removing all the material about the syntax and usage of obsolete versions of Audacity. There is also now a Legacy Wiki for die-hard users who, for whatever reason, won't or can't migrate from 1.3 or 1.2.

I still don't know what you mean by "The Book" :?

kozikowski wrote: External Links suggest something dark, forbidding, and not entirely associated with Audacity; not a way to access the Audacity program (no prefix or suffix). That's just Links (no modifiers)
As Gale explained to you earlier we need to have some external links as the software is not hosted on the Manual's domain - Audacity SourceForge site for Audacity downloads, Buanzo's site for LAME. So one again I'm unclear about precisely what you are getting at here - could you explain a bit more


Cheers,
Peter.
________________________________________FOR INSTANT HELP: (Click on Link below)
* * * * * FAQ * * * * * Tutorials * * * * * Audacity Manual * * * * *

waxcylinder
Forum Staff
Posts: 14684
Joined: Tue Jul 31, 2007 11:03 am
Operating System: Windows 10

Re: Add a tab to the instruction book

Post by waxcylinder » Wed Jul 30, 2014 10:38 am

kozikowski wrote:But I do want real external links. User supplied software, experimental stuff, "floobydust" I think one company called it.

If that makes you nervous, then links to places where you can look up user-supplied, experimental, etc. If that's a monumental task, then that's the real task. Garden hosing programs, filters, effects, etc over a wide area is not particularly good bookkeeping.
Floobydust (love that word) like that belongs in the Wiki and not in the Manual imo - if you let us know what floobydust you want we can put it in the Wiki. Or maybe you have your own Wiki editing account?

Cheers,
Peter.
________________________________________FOR INSTANT HELP: (Click on Link below)
* * * * * FAQ * * * * * Tutorials * * * * * Audacity Manual * * * * *

Gale Andrews
Quality Assurance
Posts: 41761
Joined: Fri Jul 27, 2007 12:02 am
Operating System: Windows 10

Re: Add a tab to the instruction book

Post by Gale Andrews » Wed Jul 30, 2014 4:27 pm

waxcylinder wrote:I tried to remove one of your unslicks yesterday by adding a clear link for Audacity downloading to the Manual's Front page. Is that now a slick?
I think it's unslick. The software download is not a help resource. If we want a download link in the body it should be a small link in the green div above. I don't think it's necessary now that the logo points to the downloads.

I'm prepared to remove the "External" from "Useful External Links" given those links will be italicised in the 2.0.6 Manual. Though I don't think it matters much.

Gale
________________________________________FOR INSTANT HELP: (Click on Link below)
* * * * * Tips * * * * * Tutorials * * * * * Quick Start Guide * * * * * Audacity Manual

waxcylinder
Forum Staff
Posts: 14684
Joined: Tue Jul 31, 2007 11:03 am
Operating System: Windows 10

Re: Add a tab to the instruction book

Post by waxcylinder » Wed Jul 30, 2014 4:50 pm

An aside here - I'm pondering why on earth we promote obsolete unsupported 1.2 on the front page of the alpha Manual :o :roll: :?:

"Click here for legacy 1.2 documentation. " it says in the light green box :!:

Peter
________________________________________FOR INSTANT HELP: (Click on Link below)
* * * * * FAQ * * * * * Tutorials * * * * * Audacity Manual * * * * *

steve
Site Admin
Posts: 81609
Joined: Sat Dec 01, 2007 11:43 am
Operating System: Linux *buntu

Re: Add a tab to the instruction book

Post by steve » Wed Jul 30, 2014 4:55 pm

waxcylinder wrote:I tried to remove one of your unslicks yesterday by adding a clear link for Audacity downloading to the Manual's Front page. Is that now a slick?
I think that its slick for the on-line manual, but not so slick for the downloaded manual.

For the vast majority of users, the downloaded manual was included in their Audacity download.
Anyone else that downloaded the manual (separately from Audacity) must surely be able to download Audacity (much easier than finding the downloadable manual).

I suppose that one positive benefit of a download link in the downloaded manual is that it provides a link for anyone that bought Audacity on e-bay, or received it on a cover disk or with a USB device.

Perhaps a "more slick" alternative would be a link for "Latest Version", or "Update Audacity".
I couldn't find anything obvious in the manual telling me how to update to the latest version of Audacity.
9/10 questions are answered in the FREQUENTLY ASKED QUESTIONS (FAQ)

steve
Site Admin
Posts: 81609
Joined: Sat Dec 01, 2007 11:43 am
Operating System: Linux *buntu

Re: Add a tab to the instruction book

Post by steve » Wed Jul 30, 2014 4:57 pm

waxcylinder wrote:"Click here for legacy 1.2 documentation. " it says in the light green box
And NO documentation for Audacity 0.8 :shock:
9/10 questions are answered in the FREQUENTLY ASKED QUESTIONS (FAQ)

waxcylinder
Forum Staff
Posts: 14684
Joined: Tue Jul 31, 2007 11:03 am
Operating System: Windows 10

Re: Add a tab to the instruction book

Post by waxcylinder » Wed Jul 30, 2014 4:58 pm

Gale Andrews wrote:
waxcylinder wrote:I tried to remove one of your unslicks yesterday by adding a clear link for Audacity downloading to the Manual's Front page. Is that now a slick?
I think it's unslick. The software download is not a help resource. If we want a download link in the body it should be a small link in the green div above. I don't think it's necessary now that the logo points to the downloads.
I *really* don't want to clutter the green div - and even though there is a link in the logo, that remains an easter-egg that may readers will not discover.

We could consider putting it in Using Audacity>Quick Help above Getting Started - that subsection could benefit from a second entry - and there is one spare line on the left hand side.

Peter.
________________________________________FOR INSTANT HELP: (Click on Link below)
* * * * * FAQ * * * * * Tutorials * * * * * Audacity Manual * * * * *

waxcylinder
Forum Staff
Posts: 14684
Joined: Tue Jul 31, 2007 11:03 am
Operating System: Windows 10

Re: Add a tab to the instruction book

Post by waxcylinder » Wed Jul 30, 2014 4:59 pm

steve wrote:
waxcylinder wrote:"Click here for legacy 1.2 documentation. " it says in the light green box
And NO documentation for Audacity 0.8 :shock:
I do have 0.8 on my PC :ugeek:
________________________________________FOR INSTANT HELP: (Click on Link below)
* * * * * FAQ * * * * * Tutorials * * * * * Audacity Manual * * * * *

Locked