close
Comments you submit will be routed for moderation. If you have an account, please log in first.
Modify ↓

Opened 12 months ago

Closed 5 months ago

#306 closed task (fixed)

Convert amigaguide-based documentation to online version

Reported by: damato Owned by:
Priority: normal Milestone: YAM 2.8
Component: documentation Version: 2.7
Severity: major Keywords:
Cc: Blocked By:
Blocking:
Release Notes:

Description

Phenomenon

All the amigaguide documentation is way outdated and there seems to be no people available or motivated enough to continue to update the amigaguide documentation.

Background analysis

Current amigaguide documentation is based on 2.5 and just got a minor update with 2.6 and 2.7. Arexx documentation is also not uptodate and it is questionable what else is missing/outdated.

Implementation recommendation

Amigaguide-based documentation should be converted to online documentation under the wiki engine of yam.ch. Similar to the FAQ (faq.yam.ch) this would provide an easier and better maintainable way of documenting things. After the conversion the amigaguide documentation should be considered obsolete and pressing the "HELP" key in YAM should open the online documentation rather than opening the amigaguide documentation.

Attachments (0)

Change History (2)

comment:1 Changed 7 months ago by damato

(In [6403]) * mui/YAMApplication.c: changed the MUIM_Application_ShowHelp method to

open an URL rather than opening the amigaguide based documentation file
because the guide is largely outdated and will most probably be never
be updated to the recent versions of YAM. Rather than using amigaguide
YAM will start using a web-based documentation wiki which has certainly
a higher probability of being updated in the future. Thus, pressing HELP
will now open a URL starting with "http://yam.ch/wiki/Documentation"
where in future we will see the whole amigaguide documentation be ported
and even available in multiple languages. Please note that we are going
to change the MUIA_HelpNode attributes throughout the YAM sources with
relative links to this URL. Thus, this change refs #306 and will be closed
as soon as all HelpNodes in the YAM sources have been adapted.

comment:2 Changed 5 months ago by damato

  • Resolution set to fixed
  • Status changed from new to closed

(In [6471]) * misc: adapted all MUIA_HelpNode attributes throughout the YAM sources to match the

appropriate URLs used for the online documentation. This closes #306.

Add Comment

Modify Ticket

Action
as closed .
The resolution will be deleted. Next status will be 'reopened'.
Author


E-mail address and user name can be saved in the Preferences.

Attachments ↑ Description ↑
 
Note: See TracTickets for help on using tickets.

This list contains all users that will be notified about changes made to this ticket.

These roles will be notified: Reporter, Owner, Subscriber

  • Jens Langner(Reporter, Participant)