Re: Dash Docset for IDL 8.1 [message #81252] |
Tue, 04 September 2012 09:31 |
Michael Galloy
Messages: 1114 Registered: April 2006
|
Senior Member |
|
|
On 9/3/12 2:11 AM, kidpixo wrote:
>> On 9/1/12 9:13 AM, kidpixo wrote:
>>
>>> Hi Mike,
>>
>>> generating a sqlite database is pretty straightforward, I did all using a small piece of python and no experience.
>>
>>> If there is sqlite on a machine there is no problem to create the docSet.dsidx via IDL or generate a ASCII file with to be ingested in sqlite.
>>
>> I will look into it.
>
> I'm working a lot with IDL+Database lately. I can do something in this direction, if that can help you.
>
>>> PS: Will you be at the IDL User Group Meeting in Boulder in September? I'll be in Boulder, but I don't know if I'll have time for the meeting...
>>
>> The IDL User Group Meeting has been postponed until next February, but I live in Boulder and should be here that week.
>>
>
> Thanks for the news, I didn't notice that they postponed the meeting!
>
> Mario.
>
It's just being posted:
http://idldatapoint.com/2012/09/04/idl-user-group-meeting-po stponed/
Mike
--
Michael Galloy
www.michaelgalloy.com
Modern IDL: A Guide to IDL Programming (http://modernidl.idldev.com)
Research Mathematician
Tech-X Corporation
|
|
|
Re: Dash Docset for IDL 8.1 [message #81254 is a reply to message #81252] |
Tue, 04 September 2012 04:23  |
kidpix
Messages: 23 Registered: July 2007
|
Junior Member |
|
|
Hi,
I produced a sort of IDLdoc to Docset translator, in form of a python script.
To translate an existing IDLdoc documentation follow this steps:
1. Build the directories structure as described in http://kapeli.com/docsets/ ( or use an empty docset I prepared here http://bit.ly/Sg7C0n)
2. copy you documentation in IDLdoc.docset/Contents/Resources/Documents/
3. run the IDLdoc_docset_creation.py in the Resources/ directory
Optional : change the IDLdoc.docset/icon.png and adjust the IDLdoc.docset/Contents/nfo.plist
The python code does the following:
- scans only 2 level deep in the Documents folder
- deletes some files (all-dirs.html,all-files.html etc)
- sets as start page the dir-overview.html changing it to index.html
- gets the title from each html page
- modifies the html erasing the top banner
- writes all in the sqlite DB docSet.dsidx
In order to run properly you need to have the sqlite3,urllib,BeautifulSoup and glob modules along your python distribution.
Have fun!
Cheers,
Mario.
|
|
|
Re: Dash Docset for IDL 8.1 [message #81261 is a reply to message #81254] |
Mon, 03 September 2012 01:11  |
kidpix
Messages: 23 Registered: July 2007
|
Junior Member |
|
|
> On 9/1/12 9:13 AM, kidpixo wrote:
>
>> Hi Mike,
>
>> generating a sqlite database is pretty straightforward, I did all using a small piece of python and no experience.
>
>> If there is sqlite on a machine there is no problem to create the docSet.dsidx via IDL or generate a ASCII file with to be ingested in sqlite.
>
> I will look into it.
I'm working a lot with IDL+Database lately. I can do something in this direction, if that can help you.
>> PS: Will you be at the IDL User Group Meeting in Boulder in September? I'll be in Boulder, but I don't know if I'll have time for the meeting...
>
> The IDL User Group Meeting has been postponed until next February, but I live in Boulder and should be here that week.
>
Thanks for the news, I didn't notice that they postponed the meeting!
Mario.
|
|
|
Re: Dash Docset for IDL 8.1 [message #81268 is a reply to message #81261] |
Sun, 02 September 2012 10:49  |
Michael Galloy
Messages: 1114 Registered: April 2006
|
Senior Member |
|
|
On 9/1/12 9:13 AM, kidpixo wrote:
> Hi Mike,
> generating a sqlite database is pretty straightforward, I did all using a small piece of python and no experience.
> If there is sqlite on a machine there is no problem to create the docSet.dsidx via IDL or generate a ASCII file with to be ingested in sqlite.
I will look into it.
> PS: Will you be at the IDL User Group Meeting in Boulder in September? I'll be in Boulder, but I don't know if I'll have time for the meeting...
The IDL User Group Meeting has been postponed until next February, but I
live in Boulder and should be here that week.
Mike
--
Michael Galloy
www.michaelgalloy.com
Modern IDL, A Guide to Learning IDL: http://modernidl.idldev.com
Research Mathematician
Tech-X Corporation
|
|
|
Re: Dash Docset for IDL 8.1 [message #81282 is a reply to message #81268] |
Sat, 01 September 2012 08:13  |
kidpix
Messages: 23 Registered: July 2007
|
Junior Member |
|
|
Hi Mike,
generating a sqlite database is pretty straightforward, I did all using a small piece of python and no experience.
If there is sqlite on a machine there is no problem to create the docSet.dsidx via IDL or generate a ASCII file with to be ingested in sqlite.
Cheers,
Mario.
PS: Will you be at the IDL User Group Meeting in Boulder in September? I'll be in Boulder, but I don't know if I'll have time for the meeting...
> That's pretty cool, it's super fast access to docs. But to create a
> docset you have to generate an SQLite database, i.e., that docSet.dsidx
> file? It would be a nice feature of IDLdoc to be able to generate a
> docset from a library of IDL code, but I don't want to generate a database.
>
> Mike
|
|
|
Re: Dash Docset for IDL 8.1 [message #81290 is a reply to message #81282] |
Fri, 31 August 2012 10:22  |
Michael Galloy
Messages: 1114 Registered: April 2006
|
Senior Member |
|
|
On 8/31/12 11:16 AM, Michael Galloy wrote:
> On 8/31/12 8:18 AM, kidpixo wrote:
>> Hi,
>> I produced a easily accessible documentation file (docset) based on
>> IDL 8.1 to be used with Dash > http://kapeli.com/dash/
>>
>> It Includes also IDLdoc documentation.
>>
>> There is also a PostGIS2 docset, if you are interested. See details
>> and links here > http://bit.ly/Tzlr55
>>
>> Cheers,
>> Mario.
>>
>
> That's pretty cool, it's super fast access to docs. But to create a
> docset you have to generate an SQLite database, i.e., that docSet.dsidx
> file? It would be a nice feature of IDLdoc to be able to generate a
> docset from a library of IDL code, but I don't want to generate a database.
>
> Mike
Ah, I see, there is an alternative way using docsetutil from the
Developer Tools.
Mike
--
Michael Galloy
www.michaelgalloy.com
Modern IDL: A Guide to IDL Programming (http://modernidl.idldev.com)
Research Mathematician
Tech-X Corporation
|
|
|
Re: Dash Docset for IDL 8.1 [message #81291 is a reply to message #81290] |
Fri, 31 August 2012 10:16  |
Michael Galloy
Messages: 1114 Registered: April 2006
|
Senior Member |
|
|
On 8/31/12 8:18 AM, kidpixo wrote:
> Hi,
> I produced a easily accessible documentation file (docset) based on IDL 8.1 to be used with Dash > http://kapeli.com/dash/
>
> It Includes also IDLdoc documentation.
>
> There is also a PostGIS2 docset, if you are interested. See details and links here > http://bit.ly/Tzlr55
>
> Cheers,
> Mario.
>
That's pretty cool, it's super fast access to docs. But to create a
docset you have to generate an SQLite database, i.e., that docSet.dsidx
file? It would be a nice feature of IDLdoc to be able to generate a
docset from a library of IDL code, but I don't want to generate a database.
Mike
--
Michael Galloy
www.michaelgalloy.com
Modern IDL: A Guide to IDL Programming (http://modernidl.idldev.com)
Research Mathematician
Tech-X Corporation
|
|
|
Re: Dash Docset for IDL 8.1 [message #84695 is a reply to message #81268] |
Tue, 04 September 2012 04:12  |
kidpix
Messages: 23 Registered: July 2007
|
Junior Member |
|
|
Hi,
I produced a sort of IDLdoc to Docset translator, in form of a python script.
To translate an existing IDLdoc documentation follow this steps:
- Build the directories structure as described in http://kapeli.com/docsets/ ( or use an empty docset I prepared here http://bit.ly/Sg7C0n)
- copy you documentation in IDLdoc.docset/Contents/Resources/Documents/
- run the IDLdoc_docset_creation.py in the Resources/ directory
The python code scan only 2 level deep in the Documents folder, delete some files (all-dirs.html,all-files.html etc), get the title from each html page, modify the html erasing the top banner and write all in the sqlite DB.
Moreover, it sets as start page the dir-overview.html changing it index.html.
Have fun!
Cheers,
Mario.
|
|
|