Tutorial: clickable manual references

Tutorial: clickable manual references

[Reiner Steib]

Hi,

wouldn't it be useful to make references to the Emacs manual be
"clickable" links?

I.e. clicking on "Completion" should open (info "(emacs)Completion").

,----[ TUTORIAL ]
| Completion is described in Info in the Emacs manual in the node
| called "Completion".
`----

Bye, Reiner.
-- 
       ,,,
      (o o)
---ooO-(_)-Ooo---  |  PGP key available  |  http://rsteib.home.pages.de/

Re: Tutorial: clickable manual references

[Juri Linkov]

> wouldn't it be useful to make references to the Emacs manual be
> "clickable" links?

I'm afraid such links in the Tutorial will distract the reader
that should concentrate on the Tutorial and not to switch to
reading the Emacs manual.

> I.e. clicking on "Completion" should open (info "(emacs)Completion").
>
> ,----[ TUTORIAL ]
> | Completion is described in Info in the Emacs manual in the node
> | called "Completion".
> `----

Since this link is at the end of the Tutorial it would do no harm.
But maybe we could just teach the user how to read the Emacs manual
by adding a chapter about this to the end of the Tutorial?

-- 
Juri Linkov
http://www.jurta.org/emacs/

Re: Tutorial: clickable manual references

[Reiner Steib]

On Mon, Mar 10 2008, Juri Linkov wrote:

>> wouldn't it be useful to make references to the Emacs manual be
>> "clickable" links?
>
> I'm afraid such links in the Tutorial will distract the reader

Good point.

> that should concentrate on the Tutorial and not to switch to
> reading the Emacs manual.

But when reading it later, there should be such a possibility, I
think.  Maybe we can find a non-intrusive way.

Bye, Reiner.
-- 
       ,,,
      (o o)
---ooO-(_)-Ooo---  |  PGP key available  |  http://rsteib.home.pages.de/

Re: Tutorial: clickable manual references

[Lennart Borgman (gmail)]

Reiner Steib wrote:
> On Mon, Mar 10 2008, Juri Linkov wrote:
> 
>>> wouldn't it be useful to make references to the Emacs manual be
>>> "clickable" links?
>> I'm afraid such links in the Tutorial will distract the reader
> 
> Good point.
> 
>> that should concentrate on the Tutorial and not to switch to
>> reading the Emacs manual.
> 
> But when reading it later, there should be such a possibility, I
> think.  Maybe we can find a non-intrusive way.

Maybe put the links at the end of the tutorial?

Re: Tutorial: clickable manual references

[Juri Linkov]

>>>> wouldn't it be useful to make references to the Emacs manual be
>>>> "clickable" links?
>>> I'm afraid such links in the Tutorial will distract the reader
>>
>> Good point.
>>
>>> that should concentrate on the Tutorial and not to switch to
>>> reading the Emacs manual.
>>
>> But when reading it later, there should be such a possibility, I
>> think.  Maybe we can find a non-intrusive way.
>
> Maybe put the links at the end of the tutorial?

Good idea.  Such links could in the Footnotes sections with the
primary text referring to it like:

    Completion is described in Info in the Emacs manual in the node
    called "Completion" [1].

    ...

    (And at the end of the tutorial)

    Footnotes:

    [1] The node "Completion" in the Emacs manual (info "(emacs) Completion")

-- 
Juri Linkov
http://www.jurta.org/emacs/

Re: Tutorial: clickable manual references

[Sean Sieger]

Juri Linkov <juri@jurta.org> writes:

   Good idea.  Such links could in the Footnotes sections with the
   primary text referring to it like:

       Completion is described in Info in the Emacs manual in the node
       called "Completion" [1].

I would follow the footnote, for continuity, and, be distracted.

Re: Tutorial: clickable manual references

[Bastien]

Sean Sieger <sean.sieger@gmail.com> writes:

> Juri Linkov <juri@jurta.org> writes:
>
>    Good idea.  Such links could in the Footnotes sections with the
>    primary text referring to it like:
>
>        Completion is described in Info in the Emacs manual in the node
>        called "Completion" [1].
>
> I would follow the footnote, for continuity, and, be distracted.

Agreed.  I think we don't need to add footnotes, just an appendix
with the list of nodes that have been mentionned in the tutorial.

-- 
Bastien

Re: Tutorial: clickable manual references

[Juri Linkov]

>>    Good idea.  Such links could in the Footnotes sections with the
>>    primary text referring to it like:
>>
>>        Completion is described in Info in the Emacs manual in the node
>>        called "Completion" [1].
>>
>> I would follow the footnote, for continuity, and, be distracted.
>
> Agreed.  I think we don't need to add footnotes, just an appendix
> with the list of nodes that have been mentionned in the tutorial.

Then we should replace "Footnotes" with "References" or "Further reading".

-- 
Juri Linkov
http://www.jurta.org/emacs/

Re: Tutorial: clickable manual references

[Sean Sieger]

   Then we should replace "Footnotes" with "References" or "Further reading".

Placing the head `FURTHER READING' at the end of the tutorial, with
solely the URL for the Emacs Wiki beneath it, would be good for several
reasons:

* The Web is a great resource for accurate and erroneous information,
  referring newcomers to the wiki will help reign searches in.

* It appears that the Emacs Wiki is under-read and because under-read,
  less than optimally (?) maintained.

* There exists in the tutorial the head `GETTING MORE HELP' and the
  succinct introduction to the documentation system of Emacs.