taskLiberty Eiffel - Tasks: task #14018, Improve documentation by creating...

 
 

You are not allowed to post comments on this tracker with your current authentication level.

task #14018: Improve documentation by creating Liberty Library Functions lists

Submitted by:  Hans Zwakenberg <hzwakenberg>
Submitted on:  Thu 02 Jun 2016 07:46:38 AM UTC  
 
Should Start On:  Thu 02 Jun 2016 12:00:00 AM UTC Should be Finished on:  Sat 31 Dec 2016 12:00:00 AM UTC
Category:  other Priority:  5 - Normal
Status:  None Percent Complete:  0%
Assigned to:  Hans Zwakenberg <hzwakenberg> Open/Closed:  Open
Fixed Release:  None Planned Release:  curtiss
Effort:  0.00

Sat 22 Sep 2018 07:40:29 PM UTC, comment #4: 

One one side that could be a nice approach, but on the other side, I think we have enough to do with the existing topics and cannot even fully maintain what we have, so why should we learn yet another technology and invest time in something, that maybe by next week is obsolete. For generation we have eiffeldoc - it has some problems, but it works - and for a tutorial which describes the most important features I think the wiki is working quite well...

Raphael Mack <ramack>
Project Administrator
Wed 19 Sep 2018 01:44:25 PM UTC, comment #3: 

A main plus of Pandoc is that it handles many formats, notably it can produce mediawiki

Paolo Redaelli <Tybor>
Project Administrator
Wed 19 Sep 2018 01:42:18 PM UTC, comment #2: 

Have you considered a static web site generator?
There are plenty of those, see https://www.staticgen.com/
A couple of years ago I tried Pelican. According to https://pkgs.org/download/python-pelican it's available in Debian, Fedora and Ubuntu, but it doesn't digest mediawiki syntax.
I suggest to write tutorials and documentations in doc directory using Pandoc which is available in all widespread distributions, on Windows, MacOS and all BSDs. Its output is easily pushable on the website.

Paolo Redaelli <Tybor>
Project Administrator
Fri 14 Sep 2018 08:12:15 PM UTC, comment #1: 

I think having all the features in the wiki is not feasible. That kind of doc should be in the docs. What would be great to have in the wiki is some basic tutorial for string usage, natural numbers, containers, etc. maybe for each cluster in the libs something.

But I also agree, that searching in the docs would be great, but maybe the best would be to "just" put a search field into the docs which uses site-restricted search via google.

The perfect solution could be to generate a list of keywords of everything in the docs, and have a JS-search, that could also work offline. (On the other side: today nobody is offline during programming, isn't it?)

Raphael Mack <ramack>
Project Administrator
Thu 02 Jun 2016 07:46:38 AM UTC, original submission:  

If you want to learn what functions the Liberty library offers, you need to check the sources/documentation of individual datatypes (like numeric, string, etc.) to see what methods are implemented for that datatype.
We need to extend the documentation on our wiki such, that string-functions/methods, numeric/math functions/methods, etc. are visible and hence searcheable on separate pages.  Sort of a Liberty Library Standard or Native Functions List...

Hans Zwakenberg <hzwakenberg>In charge of this item.

 

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 Tybor (Posted a comment)
  • -email is unavailable- added by ramack (Posted a comment)
  • -email is unavailable- added by hzwakenberg (Submitted the item)
  •  

    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 logged-in users can vote.

     

     

     

    Follow 5 latest changes.

    Date Changed by Updated Field Previous Value => Replaced by
    2018-09-14 ramack Assigned toNone => hzwakenberg
    2016-06-02 cadrian Fixed Releasebell => None
    2016-06-02 hzwakenberg CategoryKernel libraries => other
        Fixed ReleaseNone => bell
        SummaryCreate a Liberty Library Functions list => Improve documentation by creating Liberty Library Functions lists

    Back to the top


    Powered by Savane 3.6