Project

General

Profile

Feature #275

improvements for help

Added by Carlos Vargas almost 10 years ago. Updated over 3 years ago.

Status:
New
Priority:
Normal
Assignee:
-
Category:
-
Target version:
Start date:
03/12/2009
Due date:
% Done:

30%

Estimated time:
Complexity:
Normal
SCRUM pts - complexity:
?

Description

The help should be improved and should be contextual.
The help should be much more extensive than is the case now and should
provide "good practices" and examples of use.

Tool developers are also required to write the manuals for it

History

#1

Updated by Carlos Vargas almost 10 years ago

Actualizado por Yannick Warnier hace alrededor de 1 año

Comment

This includes:
- creating documentation on the wiki, based on the current online documentation, and using the following syntax: DOC_EN_1.8_HOME for the Documentation in English, for version 1.8.x, for section Home
- creating an api_get_help() function in main_api.lib.inc.php which generates the link to the corresponding documentation page in the wiki
- api_get_help() should first check if the corresponding documentation page exists in the corresponding language on the wiki and use the following decisional process:
1) use online doc in corresponding language
2) use local doc in corresponding language
3) use online doc in english
4) use local doc in english

This brings us to the problem that local documentation is always using english by default if no corresponding translation has been found...
So a better order would be
1) use online doc in corresponding language
2) use online doc in english
3) use local doc in corresponding language
4) use local doc in english
#2
Actualizado por Yannick Warnier hace alrededor de 1 año

Comment

All docs created in english on the wiki. A way to hide lateral menu and styling should be found. Can be done with CSS alteration, but how can we change the CSS from Dokeos? There doesn't seem to be a way to change this setting for non-logged-in users from inside MediaWiki.
#3
Actualizado por Yannick Warnier hace alrededor de 1 año

Comment

Loading the link in the header can only be afforded in AJAX, as it might take some time and it appears on almost every page.
#4
Actualizado por Yannick Warnier hace 3 meses

  • Asignado a changed from Yannick Warnier to Julio Montoya * Versión prevista changed from 1.8.4 to 1.8.7
#2

Updated by Yannick Warnier over 9 years ago

  • Assignee deleted (Julio Montoya)
  • Target version changed from 1.8.7 to 1.8.7.1
#3

Updated by Yannick Warnier about 9 years ago

  • Target version changed from 1.8.7.1 to 1.8.8 stable
#4

Updated by Yannick Warnier over 8 years ago

  • Target version changed from 1.8.8 stable to 1.8.8.4
#5

Updated by Yannick Warnier about 8 years ago

  • Target version changed from 1.8.8.4 to 1.9 Stable
#6

Updated by Yannick Warnier over 7 years ago

  • Target version changed from 1.9 Stable to 1.9.2
#7

Updated by Yannick Warnier about 7 years ago

  • Target version changed from 1.9.2 to 2.0
#8

Updated by Yannick Warnier almost 4 years ago

The redaction of documentation on doc.chamilo.org is in progress, so we'll come back to this task later on.

#9

Updated by Yannick Warnier over 3 years ago

  • Target version changed from 2.0 to 3.0

Also available in: Atom PDF