Bugs In Xrnxstarterpack280.zip

Renoise Tool Development
1

What is: XrnxStarterPack280/Documentation/html/Default3.xml ?

Found in XrnxStarterPack280.zip.

I don’t think that file should be there?

-=-=-

Image paths in the docs are wrong.

Renoise.ViewBuilder.API.lua.html
C:/Users/edu/Downloads/XrnxStarterPack280/Documentation/html/images/Text.png

When generating the docs using the script I wrote a while back, I used to to do a “search and replace” and make it relative after the fact.

2

Oh indeed. Clearly a bug in the script I’d say <_<
Thanks. Will fix this with the next xrnx update…

3

Haha.

The variable is $CONFIG[‘IMAGES_URL’]. Keyword URL. :)

The images were supposed to be online somewhere as part of a wiki or something. This never happened. In the meantime, I half-arsed it and just manually changed it when generating the docs.

This is in the text docs too, look in Documentation/Renoise.ViewBuilder.API.lua for example.

  
-- A simple button that calls a custom notifier function when clicked.  
-- Supports text or bitmap labels.  
  
--[[  
  
--. +--------+  
--. | Button |  
--. +--------+  
  
![Button](___REPLACE_URL___/Button.png)  
]]--

That REPLACE_URL is a placeholder. It shouldn’t really be in the text docs. It was, in theory, supposed to point to a hosted image. A user could then copy paste in a web browser to look at something if needed.

Sorry if this wasn’t clear.

The script can be changed to simply copy the images/ directory to the OUT_DIR, and that REPLACE_URL thing could probably be changed too.

Look for a commit in SVN. I will do this now.

4

r1095.

5

Thanks!

6

Couldn’t help notice r1098 and had a deeper look.

So, it appears I haven’t looked at the docs since December last year and stuff has been broken for a while now.

I’m trying my best to fix this stuff on my free time for fun but my daughter just woke up from her nap and I really don’t have time. Gonna post fast and pass it on.

-=-=-

Hidden ^M characters in the file (usually garbage from Windows machines) breaks the script.

Look for them using:
$ cat -v Renoise.Song.API.lua

Fix with:
$ cat Renoise.Song.API.lua | tr -d “\r” > Renoise.Song.API.lua.new
$ mv Renoise.Song.API.lua.new Renoise.Song.API.lua

@see: r1102

-=-=-

Everytime you make a change to the docs, check the results by running the script and loading the changes in a web browser.

The script is not perfect. The regex mangling is as loose as I could make it (r891, a year ago?), but it’s up to the doc writer to conform to the syntax when it doesn’t work.

@see: r1103

-=-=-

Right now, the docs are broken in a few places. I did not have the time to correct everything.

Someone has to take ownership of this task. It’s a pain in the ass. You have to look with your eyes. No getting around it. As an aside, it feels kind of weird that you are doing this yourself Taktik. This is a grunt task, the script could be improved as part of the task, and so on…

Anyways, a good starting point is to diff r1084 and compare the changes with the web browser version of the docs.

Good luck…