Documentation for FBReader

MishaS · 07-29-2008, 04:49 AM

Documentation is not the strongest side of FBReader

We'd like to improve the situation (for quite some time now, strictly speaking

). To focus on what is the most demanded, I'm asking you: what documentation you would like to see first?

Hadrien · 07-29-2008, 05:20 AM

In which way are you involved with FBReader MishaS ? I've tried to contact Nikolay about a month ago and never got any answer.

MishaS · 07-29-2008, 05:34 AM

Quote:

Originally Posted by Hadrien

In which way are you involved with FBReader MishaS ? I've tried to contact Nikolay about a month ago and never got any answer.

I'm a co-author

I must say though that majority of coding is done by Nikolay.

As far as I know, Nikolay aims to answer all mails he receives. It's possible that yours got to his junk-mail folder.

delphidb96 · 07-29-2008, 12:37 PM

Quote:

Originally Posted by MishaS

Documentation is not the strongest side of FBReader

We'd like to improve the situation (for quite some time now, strictly speaking

). To focus on what is the most demanded, I'm asking you: what documentation you would like to see first?

First, I'd like to see a Quick Guide that goes through a simple explanation of the installation process and the more common features.

Then I'd think a more comprehensive User's Guide that details all the features. If there are scripting functions or customization features, could you include samples in the appropriate sections?

Derek

DaleDe · 07-29-2008, 01:16 PM

Quote:

Originally Posted by delphidb96

First, I'd like to see a Quick Guide that goes through a simple explanation of the installation process and the more common features.

Then I'd think a more comprehensive User's Guide that details all the features. If there are scripting functions or customization features, could you include samples in the appropriate sections?

Derek

I think it would be great is the Quick Guide installation was in our wiki on the FBReader page. We already have a list of features.

Dale

wallcraft · 07-29-2008, 02:00 PM

I second the idea of using the wiki. The only downside is that I'm not sure how easy it is to scrape the wiki to get an ebook version.

Also, if any ebook versions are in an easily edited format that would help with updating. If FBReader is upgraded to support ePub's toc.ncx file then ePub would be best. Otherwise, I think CHM is the only format currently supporting nested TOCs.

07-29-2008, 04:49 AM	#1
MishaS Connoisseur Posts: 79 Karma: 52 Join Date: Jul 2005 Location: Helsinki, Finland Device: Nokia N810/Nokia E51	Documentation for FBReader Documentation is not the strongest side of FBReader We'd like to improve the situation (for quite some time now, strictly speaking ). To focus on what is the most demanded, I'm asking you: what documentation you would like to see first?

Similar Threads
Thread	Thread Starter	Forum	Replies	Last Post
Documentation for Sigil	Valloric	Sigil	15	11-12-2010 07:37 PM
Server Documentation?	Joe McPlumber	Calibre	4	07-06-2010 12:34 AM
Technical Documentation	Gremlin	HanLin eBook	4	07-16-2009 03:24 AM
Wiki documentation	mrdini	OpenInkpot	1	10-14-2008 10:50 AM
More Detailed Documentation?	TedPark	Sony Reader Dev Corner	3	06-10-2008 10:06 PM

07-29-2008, 05:20 AM	#2
Hadrien Feedbooks.com Co-Founder Posts: 2,263 Karma: 145123 Join Date: Nov 2006 Location: Paris, France Device: Sony PRS-t-1/350/300/500/505/600/700, Nexus S, iPad	In which way are you involved with FBReader MishaS ? I've tried to contact Nikolay about a month ago and never got any answer.

07-29-2008, 02:00 PM	#6
wallcraft reader Posts: 6,977 Karma: 5183568 Join Date: Mar 2006 Location: Mississippi, USA Device: Kindle 3, Kobo Glo HD	I second the idea of using the wiki. The only downside is that I'm not sure how easy it is to scrape the wiki to get an ebook version. Also, if any ebook versions are in an easily edited format that would help with updating. If FBReader is upgraded to support ePub's toc.ncx file then ePub would be best. Otherwise, I think CHM is the only format currently supporting nested TOCs.

Advert

Advert