bugGNU Octave - Bugs: bug #44198, [octave forge] generate_html:...

 
 

bug #44198: [octave forge] generate_html: Class methods missing in function index

Submitted by:  Oliver Heimlich <oheim>
Submitted on:  Sat 07 Feb 2015 12:26:02 AM UTC  
 
Category:  Octave Forge Package Severity:  3 - Normal
Priority:  5 - Normal Item Group:  Feature Request
Status:  None Assigned to:  None
Originator Name:  Oliver Heimlich Open/Closed:  Closed
Release:  3.8.2 Operating System:  Any

Add a New Comment (Rich Markup)
   

You are not logged in

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

 

( Jump to the original submission)

Sun 17 Sep 2017 02:04:18 PM UTC, comment #7: 

thanks

Doug Stewart <dastew>
Sun 17 Sep 2017 12:49:25 PM UTC, comment #6: 

I've done the latter and published it.

Olaf Till <i7tiol>
Project Member
Sun 17 Sep 2017 11:21:15 AM UTC, comment #5: 

@dastew
The function index is created during package release. The current control pkg version predates the improvements to generate_html.

We could either make a new release of the control pkg or only make a new function index with control 3.0.0 and the current generate_html to fix the function index.

Oliver Heimlich <oheim>
Sun 17 Sep 2017 10:44:45 AM UTC, comment #4: 

I don't see the @lti functions from the control pkg, in the list

Doug Stewart <dastew>
Sun 17 Sep 2017 10:34:57 AM UTC, comment #3: 

Yes, methods are part of the function index now.

Both pages (functions by alpha and functions by package) show the @class folders and when you click on them, you can see the list of contained methods.

Bug may be closed.

Oliver Heimlich <oheim>
Sun 17 Sep 2017 09:51:21 AM UTC, comment #2: 

Thanks to work by Olaf Till, class method now appear on the own dedicated page.  For instance:

https://octave.sourceforge.io/functions_by_alpha.php?item=%40symfun%2F&type=subdir&pkg=symbolic&path=packages/symbolic/alpha/s/@symfun

Bug fixed ?

Julien Bect <jbect>
Tue 24 Feb 2015 01:16:47 PM UTC, comment #1: 

Hello Oliver,

Yes, I had noted this issue too (but omitted to file a bug report, mea culpa).

I am currently cleaning up and fixing lots of small details in the package. Once this is finished, I intend to look into this issue.

@++
Julien

Julien Bect <jbect>
Sat 07 Feb 2015 12:26:02 AM UTC, original submission:  

The following patch adds methods from @class folders to the index files and makes them available on the following pages:

http://octave.sourceforge.net/functions_by_package.php
http://octave.sourceforge.net/functions_by_alpha.php

Currently, all class methods are missing, which hides most of the interval or symbolic packages for example.

For the functions_by_alpha page, we should additionally consider the following consequences:
(1) the order of functions probably could be improved (otherwise, any @class methods would come first, sorted by class name)
(2) overridden standard function, e. g. size, probably occur in many packages and could be aggregated or displayed in a compact way

--- a/inst/generate_package_html.m        Thu Jan 22 15:25:45 2015 +0100
+++ b/inst/generate_package_html.m        Sat Feb 07 01:05:44 2015 +0100
@@ -228,7 +228,9 @@
         F = desc.provides {k}.functions;
         for l = 1:length (F)
           fun = F {l};
-          if (implemented {k}{l} && lower (fun (1)) == letter)
+          if (implemented {k}{l} && ...
+              ## class members and private functions are located in subfolders
+              lower (strsplit (fun, "/") {end} (1)) == letter)
             fs = first_sentences {k}{l};

             fprintf (name_fid, "%sn", fun);

Oliver Heimlich <oheim>

 

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

Attach Files:
   
   
Comment:
   

No files currently attached

 

Depends on the following items: None found

Items that depend on this one: None found

 

Carbon-Copy List
  • -email is unavailable- added by dastew (Posted a comment)
  • -email is unavailable- added by i7tiol (Updated the item)
  • -email is unavailable- added by jwe (Updated the item)
  • -email is unavailable- added by jbect (Posted a comment)
  • -email is unavailable- added by rik5 (Updated the item)
  • -email is unavailable- added by oheim (Submitted the item)
  • -email is unavailable- added by oheim
  •  

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

    Only project members can vote.

     

     

     

    Follow 4 latest changes.

    Date Changed by Updated Field Previous Value => Replaced by
    2017-09-17 i7tiol Open/ClosedOpen => Closed
    2017-08-13 jwe Summary[generate_html] Class methods missing in function index => [octave forge] generate_html: Class methods missing in function index
    2015-02-07 rik5 CategoryDocumentation => Octave Forge Package
    2015-02-07 oheim Carbon-Copy- => Added julien.bect@centralesupelec.fr

    Back to the top


    Powered by Savane 3.7