Jump to content


Photo

Renoise Lua API Reference (pretty html)


  • Please log in to reply
23 replies to this topic

#1 Conner_Bw

Conner_Bw

    Probably More God or Borg Than Human Member

  • Normal Members
  • PipPipPipPipPipPipPipPipPipPipPipPipPipPipPip
  • 7167 posts
  • Gender:Male
  • Location:Montreal, Quebec, Canada

Posted 15 December 2010 - 22:49

A pretty HTML version of the Renoise Lua API can be found here:

http://files.renoise.../documentation/

 

It's also contained in the StarterPack download:
http://code.google.c...xrnx/downloads/
 

---

 

How it was created:

I've been working at reformatting (and proofing) the API Documentation in combination with writing a PHP script that converts them to HTML.

The `api_to_html` script is in SVN:
> https://code.google....nk/Xtra/HtmlGen

The process of conversion involves running a series of hacks and regular expressions to end up with something parse-able by PHP Markdown and GeSHi. The design is pure CSS.

Cheers.


Edited by taktik, 04 September 2014 - 09:21.

  • taktik, It-Alien, Ledger and 2 others like this

cpu Lenovo X220, Intel i7-2640M @ 2.80GHz ×4 os Windows 10 / Ubuntu 16.04 LTS
My Homepage » : My Renoise Tools » : Normalize Your Sig » : MBC Archives »


#2 vV

vV

    God's or Borg's Chief and Ruler of All Species

  • Moderator
  • PipPipPipPipPipPipPipPipPipPipPipPipPipPipPipPip
  • 16855 posts
  • Gender:Male
  • Location:Netherlands

Posted 15 December 2010 - 23:24

* More readable than before?


Definately!
An index with clickable bookmarks (TOC) is also very welcome if possible.
Vv....


cpu Intel Core i7-4820K @3.70GHz
chipset Intel X79 chipset
mem 32 Gb 2400Mhz
os Win 7 64-bit SP1, DirectX 11
audio ESI ESP1010e - > Driver rev:2.0.6.0
video nVidia Geforce GTX780 - > Driver rev:335.23


Renoise Official Manual

#3 Conner_Bw

Conner_Bw

    Probably More God or Borg Than Human Member

  • Normal Members
  • PipPipPipPipPipPipPipPipPipPipPipPipPipPipPip
  • 7167 posts
  • Gender:Male
  • Location:Montreal, Quebec, Canada

Posted 18 December 2010 - 19:33

Definately!
An index with clickable bookmarks (TOC) is also very welcome if possible.


In the main index? Or at the top of each file? Or both? It's a good idea though I'll look into it.

I've updated the docs and the code to generate them. I've changed the output so that the code is syntax highlighted (using GeSHi):

> http://www.trotch.co...pha-version_02/

Is this better?

I have a few more days of proofreading to do, but I'm getting somewhere.

Cheers.

Edited by Conner_Bw, 22 December 2010 - 17:41.

cpu Lenovo X220, Intel i7-2640M @ 2.80GHz ×4 os Windows 10 / Ubuntu 16.04 LTS
My Homepage » : My Renoise Tools » : Normalize Your Sig » : MBC Archives »


#4 Ledger

Ledger

    Guruh Motha Fakka Knows More About Renoise Than Taktik

  • Normal Members
  • PipPipPipPipPipPipPipPipPipPipPipPipPipPip
  • 3606 posts
  • Gender:Male

Posted 18 December 2010 - 20:36

This is great Conner!


Personally I find the yellow hilighted version easier to read as the beigey text in the second seems a little washed out.

maybe an amalgamation of the two, still including syntax would be best?

--> Lua For Beginners <--
--> Lua for newbies <--

My Scripts On Forum

Top Tip!

 

cpu : Xeon 1231 v3, os : Win 7 64bit, audio: Audient iD4
posts as 4tune @ KvR and some other music related sites


#5 Conner_Bw

Conner_Bw

    Probably More God or Borg Than Human Member

  • Normal Members
  • PipPipPipPipPipPipPipPipPipPipPipPipPipPipPip
  • 7167 posts
  • Gender:Male
  • Location:Montreal, Quebec, Canada

Posted 18 December 2010 - 22:20

This is great Conner!

Personally I find the yellow hilighted version easier to read as the beigey text in the second seems a little washed out.

maybe an amalgamation of the two, still including syntax would be best?


Thanks.

Because of the way GeSHi formats the code, I can't get the exact same behaviour as in v1. But CSS tweaking is certainly possible and I've tried to do an amalgamation, like you suggested, for version 3 below:

> http://www.trotch.co...pha-version_03/

I think it's pretty good?

In any case, it's CSS so I can always tweak this after. Right now the CSS injected but once I'm near completion it will be a shared CSS file. I'm just lazy at the moment.

Thanks for the feedback so far vV and Ledger.

Edited by Conner_Bw, 22 December 2010 - 17:41.

cpu Lenovo X220, Intel i7-2640M @ 2.80GHz ×4 os Windows 10 / Ubuntu 16.04 LTS
My Homepage » : My Renoise Tools » : Normalize Your Sig » : MBC Archives »


#6 vV

vV

    God's or Borg's Chief and Ruler of All Species

  • Moderator
  • PipPipPipPipPipPipPipPipPipPipPipPipPipPipPipPip
  • 16855 posts
  • Gender:Male
  • Location:Netherlands

Posted 18 December 2010 - 23:37

In the main index? Or at the top of each file? Or both? It's a good idea though I'll look into it.


Yes i meanted the latter.
The index itself already existed, the references in the file itself does not, but that would probably mean to index based upon the header type of functions mentioned i guess.

I've updated the docs and the code to generate them. I've changed the output so that the code is syntax highlighted (using GeSHi):

> http://www.trotch.co...pha-version_02/

Is this better?

I have a few more days of proofreading to do, but I'm getting somewhere.


It is looking good, i like the v3.0 version as well.
Vv....


cpu Intel Core i7-4820K @3.70GHz
chipset Intel X79 chipset
mem 32 Gb 2400Mhz
os Win 7 64-bit SP1, DirectX 11
audio ESI ESP1010e - > Driver rev:2.0.6.0
video nVidia Geforce GTX780 - > Driver rev:335.23


Renoise Official Manual

#7 Ledger

Ledger

    Guruh Motha Fakka Knows More About Renoise Than Taktik

  • Normal Members
  • PipPipPipPipPipPipPipPipPipPipPipPipPipPip
  • 3606 posts
  • Gender:Male

Posted 19 December 2010 - 00:12

Yes, looking good,

If possible the icing on the cake would be the reserved word colours matching the renoise ones etc.

--> Lua For Beginners <--
--> Lua for newbies <--

My Scripts On Forum

Top Tip!

 

cpu : Xeon 1231 v3, os : Win 7 64bit, audio: Audient iD4
posts as 4tune @ KvR and some other music related sites


#8 taktik

taktik

    Renoise Developer

  • Admins
  • PipPipPipPipPipPipPipPipPipPipPipPipPipPipPipPip
  • 15040 posts
  • Gender:Male
  • Location:Berlin, Germany
  • Interests:füße waschen

Posted 19 December 2010 - 00:27

> http://www.trotch.co...pha-version_03/
I think it's pretty good?


Me too. Looks and reads just great!

#9 Conner_Bw

Conner_Bw

    Probably More God or Borg Than Human Member

  • Normal Members
  • PipPipPipPipPipPipPipPipPipPipPipPipPipPipPip
  • 7167 posts
  • Gender:Male
  • Location:Montreal, Quebec, Canada

Posted 22 December 2010 - 17:43

Alright,

At this point I will say that I've reached "version 1" for this effort and it's done.

@see: http://trotch.com/tmp/api_to_html-v1/

I've also attached a packaged version that you can install locally. Taktik will be putting it up in a more official manner in the upcoming days.

Thanks for the feedback.

Enjoy.

Edited by Conner_Bw, 04 January 2011 - 19:11.

  • maes likes this

cpu Lenovo X220, Intel i7-2640M @ 2.80GHz ×4 os Windows 10 / Ubuntu 16.04 LTS
My Homepage » : My Renoise Tools » : Normalize Your Sig » : MBC Archives »


#10 vV

vV

    God's or Borg's Chief and Ruler of All Species

  • Moderator
  • PipPipPipPipPipPipPipPipPipPipPipPipPipPipPipPip
  • 16855 posts
  • Gender:Male
  • Location:Netherlands

Posted 23 December 2010 - 10:52

Alright,

At this point I will say that I've reached "version 1" for this effort and it's done.

@see: http://trotch.com/tmp/api_to_html-v1/


This looks like the proper guided API documentation i'm used to... .I'm proud of you! :)
Vv....


cpu Intel Core i7-4820K @3.70GHz
chipset Intel X79 chipset
mem 32 Gb 2400Mhz
os Win 7 64-bit SP1, DirectX 11
audio ESI ESP1010e - > Driver rev:2.0.6.0
video nVidia Geforce GTX780 - > Driver rev:335.23


Renoise Official Manual

#11 Conner_Bw

Conner_Bw

    Probably More God or Borg Than Human Member

  • Normal Members
  • PipPipPipPipPipPipPipPipPipPipPipPipPipPipPip
  • 7167 posts
  • Gender:Male
  • Location:Montreal, Quebec, Canada

Posted 29 December 2010 - 20:51

I changed the way the index is generated.

I moved the attachment into the first post.

Cheers.

cpu Lenovo X220, Intel i7-2640M @ 2.80GHz ×4 os Windows 10 / Ubuntu 16.04 LTS
My Homepage » : My Renoise Tools » : Normalize Your Sig » : MBC Archives »


#12 Conner_Bw

Conner_Bw

    Probably More God or Borg Than Human Member

  • Normal Members
  • PipPipPipPipPipPipPipPipPipPipPipPipPipPipPip
  • 7167 posts
  • Gender:Male
  • Location:Montreal, Quebec, Canada

Posted 04 January 2011 - 17:53

HTML docs were moved to the StarterPack:

http://code.google.c.../downloads/list

Done!

cpu Lenovo X220, Intel i7-2640M @ 2.80GHz ×4 os Windows 10 / Ubuntu 16.04 LTS
My Homepage » : My Renoise Tools » : Normalize Your Sig » : MBC Archives »


#13 IgsterKicks

IgsterKicks

    New Member

  • Normal Members
  • Pip
  • 3 posts

Posted 04 March 2015 - 15:06

Been doing some scripting, the documentation is pretty good! For future updates, can we please get a basic search feature? Or I'd even take all APIs in a single html file, so it's all ctrl+f searchable. Song.API is the the main and largest one, but sometimes you want to check something in the other parts of the API and then have to go back to the index, figure out which one to open,  etc.



#14 ffx

ffx

    Composes without Wires burns Directly from Brain to DVD that is already in Store Member

  • Normal Members
  • PipPipPipPipPipPipPipPipPipPipPipPipPipPip
  • 3442 posts
  • Gender:Not Telling

Posted 02 January 2016 - 10:56

I would like to suggest a little better structured documentation.... :P

 

IMHO even using this "pretty-html" version, it's still a pain in the ass to use it.

 

I basically miss a staying menu/navigation on the left, and a method index. Even a javascript search would be completely overdope. I mean really documentation standards that where introduced around the early 90's......

 

 

EDIT:

 

And cross linking would help, too :)  Like, return type is "-> [array of renoise.PatternLine objects]", <- then clickable "renoise.PatternLine" with a link to that definition.

 

The navigation could consist of the method index in openable/closable sub-nodes / in a tree structure.


Edited by ffx, 04 January 2016 - 15:00.

  • Conner_Bw, fladd, mystical&magical and 1 other like this

Test system: macOS 10.13.4, HFS+. Firewire Audio, i7 4770, 8GB Ram, GTX1050 2GB, 48kHz
GUI Automation RecorderNative DSP Context MenuTuned ShortcutsUnified Value Shift And Transpose | Jump To From Send Modified (Docs) | Quick Template | Nisanmol's Groove Tool FixedThemes


#15 Sparky

Sparky

    Super Advanced Member

  • Normal Members
  • PipPipPipPip
  • 155 posts
  • Gender:Male
  • Location:New Zealand
  • Interests:Progressive metal and electronica. Playing guitar. Kayaking, mountain biking, road biking and walking. Spending time with my two children.

Posted 07 May 2018 - 02:19

A pretty HTML version of the Renoise Lua API can be found here:

http://files.renoise.../documentation/

 

It's also contained in the StarterPack download:
http://code.google.c...xrnx/downloads/

 

Whereabouts is the HTML in the download? I can only find .Lua files for the documentation.

 

Should the HTML be generated from the .Lua files somehow?



#16 ffx

ffx

    Composes without Wires burns Directly from Brain to DVD that is already in Store Member

  • Normal Members
  • PipPipPipPipPipPipPipPipPipPipPipPipPipPip
  • 3442 posts
  • Gender:Not Telling

Posted 07 May 2018 - 08:40

http://files.renoise.../documentation/

 

But it is outdated, and there is no information, if the Renoise team will add missing points.


Test system: macOS 10.13.4, HFS+. Firewire Audio, i7 4770, 8GB Ram, GTX1050 2GB, 48kHz
GUI Automation RecorderNative DSP Context MenuTuned ShortcutsUnified Value Shift And Transpose | Jump To From Send Modified (Docs) | Quick Template | Nisanmol's Groove Tool FixedThemes


#17 Sparky

Sparky

    Super Advanced Member

  • Normal Members
  • PipPipPipPip
  • 155 posts
  • Gender:Male
  • Location:New Zealand
  • Interests:Progressive metal and electronica. Playing guitar. Kayaking, mountain biking, road biking and walking. Spending time with my two children.

Posted 07 May 2018 - 08:42

Thanks got that. I prefer a local copy but I suppose I could 'mine' the html.
  • pat likes this

#18 Conner_Bw

Conner_Bw

    Probably More God or Borg Than Human Member

  • Normal Members
  • PipPipPipPipPipPipPipPipPipPipPipPipPipPipPip
  • 7167 posts
  • Gender:Male
  • Location:Montreal, Quebec, Canada

Posted 07 May 2018 - 15:00

Requires some dev know how:

 

Clone: https://github.com/renoise/xrnx

 

Configure and run this script: https://github.com/r...er/Xtra/HtmlGen

 

Should still work?


Junky script could be improved using composer packages instead of copy/paste includes dir, contemporary PHP syntax, and so on... Patches welcome.


cpu Lenovo X220, Intel i7-2640M @ 2.80GHz ×4 os Windows 10 / Ubuntu 16.04 LTS
My Homepage » : My Renoise Tools » : Normalize Your Sig » : MBC Archives »


#19 Sparky

Sparky

    Super Advanced Member

  • Normal Members
  • PipPipPipPip
  • 155 posts
  • Gender:Male
  • Location:New Zealand
  • Interests:Progressive metal and electronica. Playing guitar. Kayaking, mountain biking, road biking and walking. Spending time with my two children.

Posted 08 May 2018 - 02:25

Requires some dev know how: using composer packages instead of copy/paste includes dir, contemporary PHP syntax, and so on... Patches welcome.

 

Yeah.. and perhaps web dev know-how too. I'd be "comfortable" running some command-line stuff on my laptop but "copy to a webserver.."... seems like a bit of a mission.



#20 Raul (ulneiz)

Raul (ulneiz)

    Guruh Motha Fakka is Levitating and Knows Everything About Renoise Member

  • Normal Members
  • PipPipPipPipPipPipPipPipPipPipPipPipPip
  • 1524 posts
  • Gender:Male
  • Location:Spain

Posted 08 May 2018 - 11:01

I wish it would update correctly. One of the advantages of having the documentation in HTML is that it is easy to translate all the information into another language (I mean the descriptions). This allows beginners to understand more quickly the API available to create tools, because they are using their language.
 
Also, I do not like too much how the jump lines are built in the documentation for the terminal (Documentation/ files.lua). For example:
 
...
renoise.song().artist, _observable
  -> [string]
renoise.song().name, _observable
  -> [string]
renoise.song().comments[], _observable
  -> [array of strings]
...
 
It seems easier to read vertically like this:
 
...
renoise.song().artist, _observable -> [string]
renoise.song().name, _observable -> [string]
renoise.song().comments[], _observable -> [array of strings]
...
 
In HTML you can play better with these things for a more pleasant reading. Help the eyes to locate the desired code faster...

:excl: Development of my tools: KangarooX120SamRenderPhraseTouch  |  GT16-Colors (old)

 

:excl: My API wishlist R3.1 (updated 24 July 2017):

Spoiler

 

:excl: My Renoise 3.1 wishlist (updated 26 September 2017):

Spoiler

#21 Conner_Bw

Conner_Bw

    Probably More God or Borg Than Human Member

  • Normal Members
  • PipPipPipPipPipPipPipPipPipPipPipPipPipPipPip
  • 7167 posts
  • Gender:Male
  • Location:Montreal, Quebec, Canada

Posted 08 May 2018 - 22:44

Yeah.. and perhaps web dev know-how too. I'd be "comfortable" running some command-line stuff on my laptop but "copy to a webserver.."... seems like a bit of a mission.

 

Life hack URL? http://files.renoise...ntation/images/


This one will also probably work (better) https://raw.githubus...HtmlGen/images/

 

Examples:

https://raw.githubus...mages/XYPad.png

https://raw.githubus...es/CheckBox.png

...


cpu Lenovo X220, Intel i7-2640M @ 2.80GHz ×4 os Windows 10 / Ubuntu 16.04 LTS
My Homepage » : My Renoise Tools » : Normalize Your Sig » : MBC Archives »


#22 Conner_Bw

Conner_Bw

    Probably More God or Borg Than Human Member

  • Normal Members
  • PipPipPipPipPipPipPipPipPipPipPipPipPipPipPip
  • 7167 posts
  • Gender:Male
  • Location:Montreal, Quebec, Canada

Posted 08 May 2018 - 22:58

Tada?

Attached Files


Edited by Conner_Bw, 08 May 2018 - 22:58.

  • Sparky, ffx, pat and 1 other like this

cpu Lenovo X220, Intel i7-2640M @ 2.80GHz ×4 os Windows 10 / Ubuntu 16.04 LTS
My Homepage » : My Renoise Tools » : Normalize Your Sig » : MBC Archives »


#23 Sparky

Sparky

    Super Advanced Member

  • Normal Members
  • PipPipPipPip
  • 155 posts
  • Gender:Male
  • Location:New Zealand
  • Interests:Progressive metal and electronica. Playing guitar. Kayaking, mountain biking, road biking and walking. Spending time with my two children.

Posted 09 May 2018 - 02:23

Tada?

 

O for Orsum, or A for Awesome. Thanks for that! :yeah:



#24 ffx

ffx

    Composes without Wires burns Directly from Brain to DVD that is already in Store Member

  • Normal Members
  • PipPipPipPipPipPipPipPipPipPipPipPipPipPip
  • 3442 posts
  • Gender:Not Telling

Posted 06 June 2018 - 19:34

danoise, can you replace with the outdated on your server?


Test system: macOS 10.13.4, HFS+. Firewire Audio, i7 4770, 8GB Ram, GTX1050 2GB, 48kHz
GUI Automation RecorderNative DSP Context MenuTuned ShortcutsUnified Value Shift And Transpose | Jump To From Send Modified (Docs) | Quick Template | Nisanmol's Groove Tool FixedThemes