[Octave-patch-tracker] [patch #8990] generate_html : Adding field (additional documentation:url) to index.html of ref-man

[Fernando Pujaico Rivera]

Follow-up Comment #2, patch #8990 (project octave):


I do not think it's a good practice expect that all documentation is joined to
source code.

I think that in the "doc/" directory  of octave package, should have a method
to generate the reference manual (offline standalone), and a mini tutorial
(manual.texi) with a bit of theory, 
As the example that you say:

options = get_html_options ('octave-forge');
options.package_doc = 'manual.texi'; # or whatever it is called
generate_package_html ('$(PACKAGE)', '$(HTML_DIR)', options)

(Thanks by the info, now I will make one.)

given that a complete tutorial, need many figures, examples  and a big
theorical explication. Packages with a big theorical charge. Package as bim,
fem-fenics, fuzzy-logic-toolkit, bsltl,tsa. 
merge all them with the source code could generate packages very heavy, being
that only a little percentage of this weigth will be to the source code. 
Maybe the packages should be separate in

packagename-1.0.0.tar.gz
packagename-doc-1.0.x.tar.gz

so that the "doc/" directory in packagename-1.0.0.tar.gz have a method to
generate a off-line standalone reference manual and mini tutorial.

And in packagename-doc-1.0.x.tar.gz should have  
* A generated (off-line standalone) version of reference manual
* A generated (off-line standalone) version of mini tutorial.
* A complete manual including theory.
Thus will be more difficult that a package turn on unmaintained, given that
other people with the adequate formation can modify and refresh the source
code.

I understand that octave-forge not should be a index page. But a link to the
official home page of package should be necesary, given that there could be
more information as: videos, examples, tutorial, book, articles  and/or 
theory itself relative to package.

Maybe my original idea should be modify to a more discreet link, that no
distract the attention of reference manual. 

I am attaching a new diff file (Adding-additional-information.diff) and a
example of reference manual (bsltl_html.tar.gz).

(file #37068, file #37069)
    _______________________________________________________

Additional Item Attachment:

File name: Adding-additional-information.diff Size:1 KB
File name: bsltl_html.tar.gz              Size:55 KB


    _______________________________________________________

Reply to this item at:

  <http://savannah.gnu.org/patch/?8990>

_______________________________________________
  Message sent via/by Savannah
  http://savannah.gnu.org/