U++ forum: Welcome to the forum

Re: Improving the organization of U++ help [message #21655 is a reply to message #21652]

Sun, 31 May 2009 13:16

mirek
Messages: 13975
Registered: November 2005

Ultimate Member

gprentice wrote on Sun, 31 May 2009 05:39

Quote:

I guess for starters, you can use what we have, just add one T++ topic with this summary that links to existing parts, leave non-existing topics without links.

Add a topic? Where? How?

Links? You mean a hyperlink? So you can't have a topic such as "Moveable" appearing directly in both UsedPackages->Core->Documents as well as in UserManual->Library->Overview->Moveable?

What is "UserManual->Library->Overview->Moveable"?

Do you propose multiple trees?

I am afraid this would lead to requests to T++ that will take a lot of time to implement.

Meanwhile, I think that for most SW products docs, hyperlinks are enough to maintain logical structure.

Quote:

Is it possible to auto-generate a pdf of the whole lot - including indexed table of contents. If pdf is too hard or nobody has acrobat pro, then html like the website.

With some effort, yes.

Would it be automated?

Can be. Not harder than html->pdf conversion, obviously.

Quote:

Maybe, but with current "traffic" this is now least of concerns..

Well if documentation is better organized, traffic might improve because people will be able to see what needs doing and also will be able to more easily find the topic they have something to contribute on. If people think their work will be ignored (as some of the tutorials contributed in the past have been) or conflict with someone else, they're not gonna be interested in contributing. A visible process is needed.

Come on. svn is good enough to manage source contributions. I do not see docs any harder.

Quote:

Will contributions and modifications be accepted blindly without checking? Revision control would help a lot.

Sure, svn. All this infrastrucre exists for more than 8 months.

Quote:

Ehm, this is what "finishing" T++ was about?

I've only loosely been following Upp for the last 3 years so I don't know what's been done. Do you think you could spell it out for me?

Ah, I see. Well, what about just scanning this "Documentation" forum for details?

Quote:

How do I get to the help info for that function without being in topic++ editor mode? (yes, I know mouse-over of the little blue box gives a popup but I want to jump into the help).

Well, nobody suggested this yet. Can be added.

Quote:

I see the "index entry" combo box in the topic++ editor and I notice stuff turns green where I've inserted "indexes" but I don't see any index turning up anywhere and no info about it in the help for topic++.

Not yet implemented. Besides, in reality, full-text search is perhaps better..

Quote:

Another problem is if you enter a search term in the help search box, the term isn't highlighted in the topic content window and there's no way to step forward and backwards through the list of matches like most search mechanisms have.

Yep. Actually, help browser is still a bit lacking. From time to time, various people suggested taking a care about it, that is why I did not got involved yet...

Mirek

Report message to a moderator