Loading...
 
Documentation

Documentation


internal help

posts: 5

It's possible I overlook a discussion, feature request or whatever but I haven't found this suggestion so far:

What about including the tikiwiki help in tikiwiki itself?
As specially for the admin section this would be a big improvement imo.

This could be realized in different ways.
- Using the "title" attribute in each html tag to give short descriptions/explainations for each function on mouse over. If a page has many options to set you get a much faster way of setting them one by one instead of looking for each function in a seperate documentation.
If people find this option annoying this option could be disabled as well so no "title" attribute gets set.
- Using a help button on each page which links to a page in the documentation explaining the current page. This could be a popup (I prefer not using popups), a new page in the current page (an options but can be annoying having to go back and forth) or opening a new page.

The last option shouldn't be a big problem if the current documentation is being structured properly for each admin page or section.
The first option is much more work but a valuable improvement.

What do you guys think, not considering the amount of work for a moment?

posts: 1001 Canada

"What do you guys think, not considering the amount of work for a moment?"lol
I'm not sure I fully understand you, did you really miss the help icons? If you're on 1.7 they should always appear, on 1.8 you must activate them in Admin Features.
The mouseover idea is interesting in a unilingual context but...there are still millions of languagesconfused I don't know any way to ask Smarty if the string was translated and I sincerely don't think there are, so I say we currently can't do that.

About the main idea, the RFC you missed is at HelpSystemFutureConcept.

Thanks for your implication.

posts: 5

> Chealer9:

> I'm not sure I fully understand you, did you really miss the help icons? If you're on 1.7 they should always appear, on 1.8 you must activate them in Admin Features.

Sorry, my bad :-D

> The mouseover idea is interesting in a unilingual context but...there are still millions of languagesconfused I don't know any way to ask Smarty if the string was translated and I sincerely don't think there are, so I say we currently can't do that.

Smarty is a different component not created by the Tiki people?
What's it about and in what way is Tiki using it? (maybe something to add to the documentation as well)
So this suggestion should go to that project than?


posts: 5

> Chealer9:

> I'm not sure I fully understand you, did you really miss the help icons? If you're on 1.7 they should always appear, on 1.8 you must activate them in Admin Features.

Sorry, my bad :-D

> The mouseover idea is interesting in a unilingual context but...there are still millions of languagesconfused I don't know any way to ask Smarty if the string was translated and I sincerely don't think there are, so I say we currently can't do that.

Smarty is a different component not created by the Tiki people?
What's it about and in what way is Tiki using it? (maybe something to add to the documentation as well)
So this suggestion should go to that project than?


posts: 1001 Canada

Smarty's our template system.
Without changing the "difficult" PHP code of Tiki, you can customize its look. By example i suppose all the site on TikiSitesBestOf must have hacked templates. You could customize yours in you templates/ folder. The .tpl files.
Smarty's a GPLed product that is now a child project of PHP.


Upcoming Events

1)  18 Apr 2024 14:00 GMT-0000
Tiki Roundtable Meeting
2)  16 May 2024 14:00 GMT-0000
Tiki Roundtable Meeting
3)  20 Jun 2024 14:00 GMT-0000
Tiki Roundtable Meeting
4)  18 Jul 2024 14:00 GMT-0000
Tiki Roundtable Meeting
5)  15 Aug 2024 14:00 GMT-0000
Tiki Roundtable Meeting
6)  19 Sep 2024 14:00 GMT-0000
Tiki Roundtable Meeting
7) 
Tiki birthday
8)  17 Oct 2024 14:00 GMT-0000
Tiki Roundtable Meeting
9)  21 Nov 2024 14:00 GMT-0000
Tiki Roundtable Meeting
10)  19 Dec 2024 14:00 GMT-0000
Tiki Roundtable Meeting