[texworks] HELP: Integrated Tw LaTeX2e Help dialogue

Paul A Norman paul.a.norman at gmail.com
Tue Jul 6 15:48:24 CEST 2010


Thanks Jonathan and Stefan!

Here is the next shot at it, I've adopted all of the recomendations I
think.  Layout system was a new experience! I've added another set of
entries to the left menu to give more fuller results (added the
Concept Index).

Couple of function changes - nothing spectacular.

Made a new directory for the user's index to go into, to protect it
from future updates. (A blank copy of the neeed file will then be
found in /html/)

Any way here goes, pleae let me know if that works cross platform.


This is a Tw help dialogue (ver 0.52) July 7th 2010 that replaces the
NASA help info.
It utilises the LaTeX2e Help work done by Karl Berry and others.

The zip completely replaces ver 0.5 released here a few days ago. If
you installed that, delete its whole directory first.

Due to Jonathan Kew and Steffan Loefer's, and others efforts, it is
fully integrated with the Tw editor, and requires no outside browser.

Down load fom here --

Unzip into your scripts folder, perhaps into a directory called
`help'. Allow decompression to `use folder names'.  Refresh your
Scripts from the Scripts Menu.

Make sure your TeXWorks document is saved first.

You can then use (Win) Alt+F1,Alt+2 together to open this help-(Help
for LaTeX2e).

In the Tw Editor, select some text first, a full command, or partial
text that you want to search for help on. (Double clicking a LaTeX
command name will select it for you.)

Further help information is available in the dialogue.


On 5 July 2010 01:03, Paul A Norman <paul.a.norman at gmail.com> wrote:
> Thanks for that Stefan,
> I had assumed that a single string would cast to a single array
> element, I am still learning what Scripting will cast automatically
> and what is required implicitly.
> Somethings are passed as variants automatically and the cast happens
> on the fly and other things don't.
> Yes that .ui xml .replace() will save us a few times in the futureI think.
> Re versions, what i am looking at here, is that some things are in 4.6
> but not 4.3, so should I limit myself to 4.3?  Or take it that
> eventually everyone with scripting dialogues will be on at least 4.6
> anyway?
> I was confused becasue I had it in the back of my mind that we were on
> or sticiking to 4.3, but in Scripting I was discovering some features
> that were from 4.6 that worked but others that didn't, and before you
> ask I can not remember which :)
> So in code for one thing I wrote `works, but not documented in 4.3'
> remmed it out and didnlt use it.
>> Maybe we should also expose a function similar to TW.platform() that
>> provides information about the Qt version available (i.e., min(Qt build
>> version, Qt runtime version))?
> You are ahead of me there, I was thinking that I should just code to
> an accepted Qt version, but maybe conditional coding may prove
> necessary.
> There will be so many people getting Tw through the MikTeX release, it
> would be good to have an automatic updater perhaps?
> Can CTAN or TUG help with a permananet site for stable releases, and
> an option for update to development releases?
> Paul
> On 4 July 2010 22:35, Stefan Löffler <st.loeffler at gmail.com> wrote:
>> Hi,
>> Am 2010-07-04 11:23, schrieb Paul A Norman:
>>> On 4 July 2010 19:40, Stefan Löffler <st.loeffler at gmail.com> wrote:
>>>> BTW: why don't you use createUI(filename, parent)
>>>> with the .ui file (parent is optional, and defaults to a global dialog)?
>>> Thanks Stefan,
>>> Reason for above is covered in the source code notes - there is an
>>> important property needing to be used that can not be accessed from
>>> QtScripting.
>> Oops, I overlooked the comment - sorry.
>> But the following seems to work for me:
>> helpLatex2e = TW.createUI(baseDir + "helpLatex2e.ui");
>> TW.findChildWidget(helpLatex2e, "helpBrowser").searchPaths = new
>> Array(baseDir + 'html');
>> I guess you might have missed the array (the searchPaths property
>> requires a QStringList, according to docs)?
>>> This will happen with a number of things that need to be localised to
>>> the User's computer, and a placeholder can be set in QtCreator then
>>> .replace(ed) in the xml before creating the dialogue from xml string.
>> That's a really clever idea! Though, as pointed out above, maybe
>> unnecessary in the present case.
>>>> This should be easier and faster than manually reading the content of
>>>> the file in the script.
>>> What Qt are actually on 4.3 or as the help about says in Tw (0.3 ver
>>> 649), Qt framework 4.6?
>> I don't really understand the question. If you're referring to which Qt
>> version we use, the answer is the following:
>> The help dialog gives the version Tw was compiled with. If you use the
>> "send mail to mailing list" menu item, you'll see even more information
>> (what version it was compiled with and what version it currently runs
>> with, which need not necessarily be the same if you didn't build Tw
>> yourself on your own machine).
>> On the other hand, we are in principal targeting Qt as far back as 4.3,
>> wherever possible. The reason for this mainly is located in the Linux
>> world, AFAIK. Ubuntu, e.g., currently has support for several concurrent
>> OS versions
>> (http://en.wikipedia.org/wiki/List_of_Ubuntu_releases#Version_timeline),
>> the oldest of which is 8.04 LTS which ships with Qt 4.3.
>> Maybe we should also expose a function similar to TW.platform() that
>> provides information about the Qt version available (i.e., min(Qt build
>> version, Qt runtime version))?
>> HTH
>> Stefan

More information about the texworks mailing list