n0On3
19th January 2003 12:14 UTC

Documentation Opinion
The NSIS version I used more was 1.98, then I changed to v2.0a7 and using v2.0b0 now.

I want to comment here that I feel uncomfortable with the new look&feel of the documentation. Of course, it's more complete than the previous, but it doesn't fit me.

This is a feeling I have for quite a long time. Today, I wanted information about getting the time stamp of a file. I clicked in "file instructions" and was not there. I searched for "time" and found that the desired information was in "Registry, INI, File Instructions".

This kind of things happen to me everytime. if I want info about "Goto" I have to use the search because I don't know if goto is a "basic instruction" a "general purpose instruction" or a "flow instruction" (now that I checked I see is a flow instruction, but I won't remember tomorrow because "goto" is kind of basic and general). The problem with searching is that goto is used in exemples and it takes a bit to find what you really want.

Today I thought that having an alphabetical list of all instructions would work for me. We can include that list as another appendix, "index of instructions", or something.

Sunjammer
19th January 2003 13:02 UTC

I fully agree.

virtlink
19th January 2003 15:40 UTC

I have HTML Workshop, with which I can create HTML-based help-files. If people want it, like it and need it, I'm willing to make a help-file for NSIS, with keywords, index and search capabilities. Ofcourse, kichik, Sunjammer and joost verburg may include the source in the CVS and releases.

Tell me if you like the idea.

mistertea
19th January 2003 18:18 UTC

What I liked most was the feature to search the page for a certain command. That's what I miss most now.

Kypec
20th January 2003 06:55 UTC

I'm missing the examples for the most of the instructions:
I mean that SYNTAX + OPTIONS is not always understood by me, I'd
like to see one or two real usage examples with short explanation
of what the result of this/that usage will be :)

JaqDraco
20th January 2003 08:36 UTC

I fully agree. I can't understand why the list of instructions on top of the docs is gone. If i'm looking for the syntax of an instrauction the whole Chapter 3 must be searched.

n0On3
20th January 2003 17:03 UTC

yeah, what JaqDraco said is what I wanted, but lacked the words :)

sdbarker
20th January 2003 18:06 UTC

The documentation system that is used to generate the NSIS documentation, Halibut, is capable of generating Win32 help files. Perhaps those could be automagically generated and included instead of, or in addition to, the HTML docs.

-Scott

jthompson
20th January 2003 19:57 UTC

With the CVS Version of NSIS:
Change "config.but" in NSISDIR\Docs\src to be:

\title NSIS Users Manual
\cfg{xhtml-leaf-level}{2}
\cfg{xhtml-leaf-smallest-contents}{3}
\cfg{xhtml-leaf-contains-contents}{true}
\cfg{xhtml-contents-depth-0}{4}
\cfg{xhtml-head-end}{<link rel="stylesheet" href="style.css" type='text/css' />}
\preamble NSIS is a free scriptable win32 installer/uninstaller system that doesn't suck and isn't huge.
\copyright Copyright (c) 2002 Nullsoft, Inc.

Then run the build.bat in NSISDIR\Docs\src. It will produce a new html doc output that looks as follows.

virtlink
20th January 2003 20:00 UTC

Nice idea. Would solve a lot of problems. And I didn't say that I don't have those problems, but since others already came up with the suggestions, why should I?

deguix
25th February 2003 06:30 UTC

Message to Konrad:

View Private Messages please! I'm waiting for more than one week and you didn't read my message!