It is currently April 23rd, 2019, 10:57 am

New Documentation

Changes made during the Rainmeter 2.5 beta cycle and earlier.
User avatar
jsmorley
Developer
Posts: 19183
Joined: April 19th, 2009, 11:02 pm
Location: Fort Hunt, Virginia, USA

New Documentation

jsmorley » October 28th, 2012, 4:02 pm

New users and old hands alike, be sure to check out the new Rainmeter Documentation at http://docs.rainmeter.net.

We hope this will make learning and using Rainmeter easier for everyone. Things are better organized, and there are links absolutely everywhere that make sure that a term or function referenced somewhere has a way to get you to the "source" information.

For those who help out here on the forums or elsewhere, be aware that most of the section "header" text on the pages, as well as the "options names" in the descriptions of things like meter and measure options can be made a link by simply holding down CTRL when you click them. That will give you a link directly to the item, E.g.:

http://docs.rainmeter.net/manual/meters/button#ButtonImage
http://docs.rainmeter.net/manual/settings#RainmeterIni

Let us know if you see any mistakes, typos, or incorrect information.
User avatar
Benjamin Linus
Posts: 171
Joined: July 12th, 2009, 4:05 pm
Location: The Island

Re: New Documentation

Benjamin Linus » October 28th, 2012, 7:02 pm

Fantastic work guys :bow:
Image
User avatar
UnforgivenRevival
Posts: 317
Joined: June 7th, 2012, 2:25 am
Location: Philadelphia, PA

Re: New Documentation

UnforgivenRevival » October 28th, 2012, 8:11 pm

It turned out great. Good job!
User avatar
AlC
Posts: 331
Joined: June 9th, 2011, 6:46 pm

Re: New Documentation

AlC » October 29th, 2012, 9:54 am

Very good work! :thumbup:
Rainmeter - You are only limited by your imagination and creativity.
Alex Becherer

Re: New Documentation

Alex Becherer » October 29th, 2012, 11:39 am

very nice. and it looks great also.
thanks.
User avatar
Mordasius
Posts: 1059
Joined: January 22nd, 2011, 4:23 pm
Location: GMT +8

Re: New Documentation

Mordasius » November 2nd, 2012, 11:59 am

Now I'm getting used to the new Manual format I rather like it. Well done all concerned. :thumbup:

There are however a few ambiguities / typos which might confuse new users.

For example in the section on Image Meters, under ImageName we have "Path of the image file" which I guess should be something like "Name of the Image file including the Path if the image file is not in the same folder as the .ini file". The Note: could also be expanded to say something like "valid extensions are bmp, jpg, gif and ico with .png being assumed if no extension is provided."

Or getting really pinickity, in the Update-Guide we have "Because [MeasureTotalC] measures the total space of the drive (which will not change), the it is safe to measure it only once". Seems the third 'the' should be deleted.

Rather than point out each and every little typo on this thread, I would like to know if there is a wiki version where users can make edits which are subject to the moderators' approval before being included?
poiru
Developer
Posts: 2877
Joined: April 17th, 2009, 12:18 pm

Re: New Documentation

poiru » November 2nd, 2012, 1:30 pm

Mordasius wrote:For example in the section on Image Meters, under ImageName we have "Path of the image file" which I guess should be something like "Name of the Image file including the Path if the image file is not in the same folder as the .ini file".
File.ext alone is actually a valid path (see the Wikipedia article). All path options (click on the "Path" link) accept either relative or absolute paths unless otherwise noted.
Mordasius wrote:Rather than point out each and every little typo on this thread, I would like to know if there is a wiki version where users can make edits which are subject to the moderators' approval before being included?
The source for the new documentation is hosted on GitHub. If you're familiar with Git and GitHub, Pull Requests are more than welcome. (If not, wait for our basic tutorial on the matter in the near future.)
User avatar
Mordasius
Posts: 1059
Joined: January 22nd, 2011, 4:23 pm
Location: GMT +8

Re: New Documentation

Mordasius » November 2nd, 2012, 1:44 pm

poiru wrote:File.ext alone is actually a valid path (see the Wikipedia article). All path options (click on the "Path" link) accept either relative or absolute paths unless otherwise noted.
Point taken, but if I were a new user I think I'd be better informed seeing something along the lines of "Name of the Image file with a valid Path... rather than something beginning with "Path of the image file." Haviing links is a great idea but I don't think new users should have to click on too many to get to the basics.

I also seem to remember a couple of times when new users have asked or had to be told what file extensions are valid with ImageName.
User avatar
jsmorley
Developer
Posts: 19183
Joined: April 19th, 2009, 11:02 pm
Location: Fort Hunt, Virginia, USA

Re: New Documentation

jsmorley » November 3rd, 2012, 11:10 am

Mordasius wrote: I also seem to remember a couple of times when new users have asked or had to be told what file extensions are valid with ImageName.
I added that here: http://docs.rainmeter.net/manual/meters/general-options/image-options
User avatar
eclectic-tech
Rainmeter Sage
Posts: 3291
Joined: April 12th, 2012, 9:40 pm
Location: Cedar Point, Ohio, USA

Re: New Documentation

eclectic-tech » November 9th, 2012, 2:55 am

Minor Typo in Section Variables XY last sentence...
This also means that for a string meter with StringAlign options, the value of [MeterName:X] and [MeterName:Y] may not the same as the option values.
I believe this needs the word "be" inserted:
This also means that for a string meter with StringAlign options, the value of [MeterName:X] and [MeterName:Y] may not be the same as the option values.