You are here

Wiki

Hello,
I see good PDF manual for Qtractor but not much tutorials online. I like OSS but do not have much money, so I donate time instead. I wonder if you interested in setting up a Wiki for Qtractor and other tools. Although PDF covers well I think it helps if people also have online reference. Anyway, if you interested I can help editing Wiki, just a thought. I have edited Wikipedia and one other Wiki for a OSS project before, so I know how to edit well. But I won't lie, I can't host it :) Not a super good offer, I know, but maybe it could help people, even if it is close copy of PDF.

Forums: 
rncbc's picture

hi yuba

holy thanks for your reply and review.

i will try to check all those issues one at a time soon.

one thing i might already rebate re.- "Manual - Table of Contents" chapter is on p147:
in fact, i believe that it all sorts to title/wiki-section alphabetic order, i mean, for instance, if it's like "Manual - 0 Table of Contents" then it would be put on top and first--just my guessing.

things are like that,

  1. this kind of automated generation spree is indeed supposed to be corrected and refined as an on-going process--it is not a finished product, quite far from that;
  2. though, this all might also infer that current wiki naming and titling convention should adapt accordingly--i believe that stems from the above sorting issue, am i right? :).

ok. soon today, later perhaps, i'll refresh the regeneration process/script, taking into account some fixes from your input above, and propose yet another rendering, adding to that an automated html+epub+pdf generation in one go, thanks to pandoc of course :)

byee && cheers.

rncbc's picture

Some issues have been fixed now, while others not yet, specially the links to sub-sections on the .epub/.pdf, but probably alright on the .html rendering, go figure:)).

Good news are that there's only one single generator script for all output targets:

  1. Qtractor Manual & How To's: [epub] [pdf]
  2. Qtractor Wiki Home: [html]

[UPDATE] once again, all has been updated from wiki+attachments export as of qtractor-backup-2017-03-08-102040 and the epub/pdf are time-stamped as 2017-03-08 10:23+0000.

Enjoy.

Thanks for this. It's looking even better :-) Have had another look and noticed a few things. I'll start with the PDF, but many of the issues apply to other formats.

PDF
- margins: the left/right margins are rather wide. Is this intentional? Personally, I think it'd be better to narrow them, as it'd look more like a "book" and also help to display wide images more clearly. For example, the screenshot above "Audio and MIDI tracks in the main workspace of Qtractor" is a bit squashed
- images: many of the images look a bit fuzzy - is this down to the conversion process, or due to their original size/quality? As an example, "Track window for a MIDI track" looks fairly sharp on the wiki but fuzzy in the pdf (no matter what the zoom). Again, perhaps this might improve if the margins were narrowed
- links: from your comments, it seems you're still working on the links, but FYI, the URLs in Chapter 6 aren't actual hyperlinks, merely text. They're links in the original wiki. Those in Chapter 2 seem fine
- extraneous line: at "Punch in/out range (purple markers) inside a loop range (green markers)", there's an extra, cut-off line above this - "punch in/out range inside a loop range" - which doesn't appear in the wiki. This occurs in two places
- pagination: the "“Spline” automation mode" text and its screenshot are unfortunately on different pages. I'm not sure if it's possible/desirable to check for things like this and keep them together? Similarly, it might be nice to start each new Chapter on a new page, though it's not absolutely necessary
- link colours: intra-document/external links are the same colour/style as the rest of the text, making them difficult to see (even more difficult than the links on rncbc.org :-)). It'd probably be better to distinguish these somehow (different colour or whatever)
- extraneous link?: under each Chapter title is a link "Manual - Table of Contents" - is this intentional? I see you've deleted the [TOC] links from the wiki, but "Manual - Table of Contents" is still there. Anyway, it's up to you whether you want to keep it - I'm fine either way

HTML
- Table of Contents: this is much easier to read now, but it'd be nice if the vertical spacing were consistent. It's not a major issue, but at the the moment there's a decent-sized space under e.g. 2.1, but not under sections with sub-chapters, e.g. 2.2.2. If you prefer to keep sections tightly together as they are now though, no problem

EBOOK
- links: again, from your comments I think you're still working on this but just FYI, for Specifically, see [here] for more information on working with MIDI and [here] for audio. that I mentioned in my original post, the audio link is now correct but the MIDI one isn't. Connections is now fine

ALL
I suppose the files should have more descriptive file names than just "wiki", but this can come later.

Finally, on your point:

b. though, this all might also infer that current wiki naming and titling convention should adapt accordingly

Let me know if you think this is necessary (whenever you've decided). I'm sure you're aware but it's a bit fiddly to change titles in the wiki as you need to update all links too (it's not automatic). If it needs to be done, though, no problem.

rncbc's picture

thanks again Yuba

most of the issues you found, specially regarding the PDF formatting, are in fact due on default pandoc and its own pdflatex style, whatever--so, for the time being they'll stay as is, unless you or someone delves into custom pandoc template styling and/or offers the expertise to make it better ;) meanwhile i think we can live with those and as time permits i'll try to fix some one way or another (but make no promises :))

re. links on the epub/pdf, section 3.6. Next Steps: they all seem fine and correct to me. are you reading from the latest and updated rendering?

re. extraneous link?: yes, that's intentional and in fact are on all source wiki pages [Manual - Table of Contents]; i've deleted the [TOC] links from the wiki source just because these were being automatically converted to a table of contents of the single page where it was inserted.

re. HTML - Table of Contents: yes, vertical spacing is not very consistent as you say, but that's something that pandoc is doing in beyond our backs:) anyways, something to watch out for and improve, nevertheless.

re. files should have more descriptive file names: i agree. What about "Qtractor Manual & How To's" ?

all in all i believe it's almost ready for making it official as soon those later wrinkles become ironed out. what do you think?

[UPDATE] once again, all has been updated from wiki+attachments export as of qtractor-backup-2017-03-08-102040 and the epub/pdf are time-stamped as 2017-03-08 10:23+0000.

cheers

Thanks again for this. On your points:

- section 3.6. Next Steps: yes, it does look fine now. I did grab the latest files but perhaps was looking at a previous one for this comment - sorry
- descriptive file names: yes, the title's fine by me

Yes, I think it's easily good enough for public consumption whenever you're happy with it. As with everything else, it's an ongoing thing and having it out there in some form is better than not having it at all :-)

rncbc's picture

thanks, yet again yuba!

one more question, also standing for all the others...

what you think should be the authors line on the epub/pdf ? currently it's something as bland as "Qtractor Wiki", but i'm sure you all deserve something bigger and way more concrete ;)

nb. the "rncbc et al." in the epub/pdf title pages, are simply tags who has kicked-off the whole pandoc conversion process--it is not the real, nor actual, contents authorship.

[UPDATE] once again, all has been updated from wiki+attachments export as of qtractor-backup-2017-03-08-102040 and the epub/pdf are time-stamped as 2017-03-08 10:23+0000.

now with suggested filenames:

  1. Qtractor Manual & How-To's: [epub] [pdf]
  2. Qtractor Wiki Home [html]

BTW. All's pre-released on site already:

nb. not yet official but almost ;)

thanks
byee

> what you think should be the authors line on the epub/pdf ?
Personally, I'm not bothered about a credit, so using "rncbc et al." for this too is fine by me (with the instance above "Manual - Table of Contents" removed/set to a space if you need something in there).

If other people do want their names in, mine (Yubatake) can go in too, but it seems that many people have contributed to the documentation over the years, so putting them all in at the start might look messy. In such case, you could perhaps use "rncbc et al." as above and put the "full" credits list at the back or something (perhaps as another wiki page so the latest version gets pulled in each time).

Anyway, as I say, I'm fine without a concrete credit :-)

rncbc's picture

ok. so it all stays as is: implicit authorship = "Qtractor Wiki"...

btw. the standalone html renderings now have a custom stylesheet, consistent with the qtractor.org/qtractor.sf.net website.

[UPDATE] once again, all has been updated from wiki+attachments export as of qtractor-backup-2017-03-08-102040 and the epub/pdf are time-stamped as 2017-03-08 10:23+0000.

enjoy && thanks.
cheers

OK, thanks for the update. The html version looks good with the stylesheet.

Pages

Add new comment