Loading...
 
Skip to main content

Author Coffeeshop


New documentation file: Tiki198alpha.pdf

posts: 33

Hi:

What about some new pdf file with the updated documentation to be released with 1.9.8?
There have been quite a lot of work improving documentation on doc.tw.o in the previous months, and I honestly think, that if we still aim to make some pdf file after 1.6 pdf file, this is the right time to do it. 😊

I've invested 6 hours today to make this draft (several tasks from filling up and editing some pages at doc.tw.o to editting on local OOo, ...):

Can we call it a kind of 1.9.8 alfa?

Please, review your favourite feature, or the missing gaps, and improve it (watch out: 750+ pages!!!) on doc.tw.o tiki.

http://doc.tikiwiki.org/files/Tiki198alpha.pdf (9.9Mb)

http://doc.tikiwiki.org/files/Tiki198alpha.odt (14 Mb)

I suggest to announce a release of the pdf in alpha state to new users whenever 1.9.8rc1 is released (following your naming convention and feasible plans, Marc Laporte, for the following days/weeks)

There are some issues that, it solved from coders, they would make easier to produce next documents like the pdf ones:

(1) Page Title is not automatically shown on wiki pages on the server, and thus, manual header1 was added everywhere (Almost). But when printing to html, page title is duplicated. => if Show Page Title option is disabled under "Admin > Wiki", Page title should not be added automatically at print-to-html time.

(2) to produce the same structure (same level structure of headings) as in table of contents http://doc.tikiwiki.org/Documentation , some hack (optional) would be very welcome so that heading 1 in doc.tw.o pages is not printed as heading 1 in through the multiprint, but as header 2, at least. (optional).
This is, for instance, what is produced when printing a full structure from a Workspace - AulaWiki Mod - : a coder could grab the code from AulaWiki Mod as a reference....
In there, the description of the page is set as the Page title (header 2, I think), and the page title is included below for completeness (in lower font, and with version number next to it)...

(3) Numbering of headings: somehow, in Workspaces this is handled internally, and the user/documenter doesn't need to bother with manual numbering: it's produced also at print time.
http://edu.tikiwiki.org/tiki-workspaces_view_structure.php?print=4

Example of print structure differences between Tiki's multi-print and Workspaces print structure:

Print to html "Aula-Wiki Tutorial" from here:
http://edu.tikiwiki.org/tiki-print_pages.php

or from here:
http://edu.tikiwiki.org/tiki-workspaces_view_structure.php?print=4

Well, as you could imagine, some changes to the code to make the work of documenters a bit easier would be very wellcome also... 😊

And congratulations to all people that make that possible (coders, documenters, ...)

Cheers,

Xavi

P.S: I cannot believe it myself! We are going to release a new documentation pdf file! 😀
P.S.2.: Gary (chibaguy), I took some code and screenshots from themes.tw.o into the correspondent pages of the document. I hope it is ok with everybody (screenshots of gpl'd software are not gpl'd isn't it 😉


posts: 18 United States

> Hi:
>
> What about some new pdf file with the updated documentation to be released with 1.9.8?
> There have been quite a lot of work improving documentation on doc.tw.o in the previous months, and I honestly think, that if we still aim to make some pdf file after 1.6 pdf file, this is the right time to do it. 😊
>

Yes, do it now and don't be afraid to release revisions once a month.

> I've invested 6 hours today to make this draft (several tasks from filling up and editing some pages at doc.tw.o to editting on local OOo, ...):
>
> Can we call it a kind of 1.9.8 alfa?

Thank you for your effort. Certainly 1.9.8. alpha for this. Then 1.9.8.x as we revise.
>
> Please, review your favourite feature, or the missing gaps, and improve it (watch out: 750+ pages!!!) on doc.tw.o tiki.
>
> http://doc.tikiwiki.org/files/Tiki198alpha.pdf (9.9Mb)
>
> http://doc.tikiwiki.org/files/Tiki198alpha.odt (14 Mb)
>
> I suggest to announce a release of the pdf in alpha state to new users whenever 1.9.8rc1 is released (following your naming convention and feasible plans, Marc Laporte, for the following days/weeks)

After I test links, I'll start on this.

(coder stuff snipped....)

Thanks again xavi!

Dave

posts: 55 Canada

755 pages!

wow!

M 😉