bugKawa - Bugs: bug #42982, Documentation should be available...

 
 

bug #42982: Documentation should be available in one big page

Submitted by:  None
Submitted on:  Thu 14 Aug 2014 06:23:47 AM UTC  
 
Category: NoneSeverity: 3 - Normal
Item Group: Documenatation missingStatus: Fixed
Privacy: PublicAssigned to: Per Bothner <bothner>
Open/Closed: Open

Add a New Comment(Rich Markup)
   

You are not logged in

Please log in, so followups can be emailed to you.

 

Thu 28 Jul 2016 11:31:03 PM UTC, comment #5:

I've started making more complete binary builds and snapshots - and these include the Kawa manual on the form of an epub file.

Download ftp://ftp.gnu.org/pub/gnu/kawa/kawa-latest.zip, unzip, and then make use of doc/kawa-manual.epub.

Per Bothner <bothner>
Project AdministratorIn charge of this item.
Thu 14 Aug 2014 06:39:40 PM UTC, comment #4:

It's easy with pandoc. Here is how I did it:

% makeinfo -I. --html --no-headers --no-split --no-number-sections kawa.texi -o kawadoc.html
% pandoc -o kawadoc.epub kawadoc.html

I think pandoc can convert directly from texinfo to epub, but I didn't try it.

Anonymous
Thu 14 Aug 2014 05:21:47 PM UTC, comment #3:

Ah. I hadn't realized some platforms might make it difficult to read/browse a collection of web pages.

It is possible to get the Kawa manual as a pdf, but that isn't very small-screen-friendly either.

I don't know how difficult making a epub would be, but that might be a good solution. I'll look into it.

Per Bothner <bothner>
Project AdministratorIn charge of this item.
Thu 14 Aug 2014 05:08:46 PM UTC, comment #2:

Well, it was morning, I had just learned about Kawa and wanted to read about it in the subway on my way to work. I don't have apps in my android device that allow me to navigate between local HTML pages, but I can keep a page loaded in the browser or read it with Cool Reader. A big page (or an EPUB) would've been ideal for me then.
So... that's the "user story".

Anonymous
Thu 14 Aug 2014 06:55:38 AM UTC, comment #1:

I agree that being able to download and read documentation offline is useful (I have a lot of downloaded manuals).

However, "one big page" seems an awkward way to do that. It seems harder to read that way, and it wouldn't get other documention (as as the API documentation, or the internals manual).

A better solution would be to make the doumentation available as an archive, which I've done in the past.

You can of course download the documentation yourself using wget. Perhaps I should write up instructions for that.

The manual itself is available in the source code. You can make a basic html version thus:
cd doc; make html
It's not as nice as the website, tough.

Per Bothner <bothner>
Project AdministratorIn charge of this item.
Thu 14 Aug 2014 06:23:47 AM UTC, original submission:

Documentation should be available in one big page, so it can be downloaded and read offline (for example, in a handheld device).

Most GNU projects offer that possibility.

Anonymous

 

(Note: upload size limit is set to 16384 kB, after insertion of the required escape characters.)

Attach File(s):
   
   
Comment:
   

No files currently attached

 

Depends on the following items: None found

Items that depend on this one: None found

 

Carbon-Copy List
  • -unavailable- added by bothner (Posted a comment)
  •  

    Do you think this task is very important?
    If so, you can click here to add your encouragement to it.
    This task has 0 encouragements so far.

    Only logged-in users can vote.

     

    Please enter the title of George Orwell's famous dystopian book (it's a date):

     

     

    Follow 3 latest changes.

    Date Changed By Updated Field Previous Value => Replaced By
    Thu 28 Jul 2016 11:31:03 PM UTCbothnerStatusConfirmed=>Fixed
    Thu 14 Aug 2014 05:21:47 PM UTCbothnerAssigned toNone=>bothner
    Thu 14 Aug 2014 06:55:37 AM UTCbothnerStatusNone=>Confirmed

    Back to the top


    Powered by Savane 3.1-cleanup1