Is QuickRef available as PDF?
Author: algtrader
Creation Date: 1/19/2018 5:52 AM
profile picture

algtrader

#1
From searching the Forum posts, and articles in the WLWiki, Help->QuickRef is given as the place to look for (most) of the public class methods.

Can the WLP decision makers consider creating a PDF version of the QuickRef documentation contents?It would be an extremely helpful reference tool.

Help->Quickref is a real pain to use, Now, I have to be running WLP just so I could look at the documentation of a method.

I do most of my development and unit testing inside VIsual Studio 2017 Community Edition, and so I don't want to keep bringing up WLP whenever I want to look at the reference,.

/AL
profile picture

Eugene

#2
You express a good idea to have an online / offline (PDF) version of the QuickRef which does not depend on WL. I agree that it might be convenient for developers. Problem is, the QuickRef contents is generated by an in-house tool and there's no export facility. The good thing is that it's stored in an open format (XML). With some effort a conversion to HTML/PDF looks possible from a technical standpoint. But given that your request is not popular it would not get prioritized by the decision makers.
profile picture

Eugene

#3
Well, I got this done. An export tool I just built will traverse the QuickRef and save each category with its contents and code samples into a HTML file. (PDF format requires more effort due to a need to support CSS styles to render code examples.) HTML is as good as PDF and you could export it to PDF online or using MS Office/LibreOffice.

Let me confirm if it's okay to publish the content and get back to you.
profile picture

Eugene

#4
Our consensus is that there's no harm done. QuickRef in HTML attached.
profile picture

Eugene

#5
Here you go. Ran those HTML files through PDF Joiner. Check out the Wiki FAQ to grab your PDF:

How to print the PDF manual?
profile picture

algtrader

#6

THANK YOU, THANK YOU!!!
THIS MADE MY DAY!!!!
WOHOO!!!
profile picture

algtrader

#7

I used Chrome to print the files to PDF, then used pdfsam (pdf split-and-merge) to merge them all into 1 pdf file.
See attached,

Again, THANK YOU VERY MUCH!!!!

profile picture

Eugene

#8
Always a pleasure to help.

P.S. The Wiki already has a single-file PDF (see post #5) but let there be two now :)
profile picture

Eugene

#9
Updated QuickRef's PDF in the Wiki with the version to be released with WLP 6.9.21.x.
Includes additions and improvements to ClearDebug and FundamentalItem Object > GetDetail
Anyone interested can grab it from here:

How to print the PDF manual?
profile picture

Cone

#10
It doesn't seem so "quick" if you use it as a PDF :?

Everyone knows that F11 (or even F1 from the Editor) brings up the QuickRef - and it will navigate right to the WealthScript method under the cursor - right?
This website uses cookies to improve your experience. We'll assume you're ok with that, but you can opt-out if you wish (Read more).