It is currently February 5th, 2023, 8:08 pm

Small docs suggestions

Discussions about the documentation, main Rainmeter site and forums.
User avatar
jsmorley
Developer
Posts: 22558
Joined: April 19th, 2009, 11:02 pm
Location: Fort Hunt, Virginia, USA

Re: Small docs suggestions - Tuple

Post by jsmorley »

Jeff wrote: September 13th, 2022, 12:02 pm Just the small suggestion of adding the tuple return function to the Update section of the Lua Scripting page
  • return 99, 'Ninety-Nine'
    Provides 99 as the number value and 'Ninety-Nine' as the string value. Usage depends on a Measure's individual binding, the values can also be retrieved using Measure Section Variables (Example: Text="Num = [MeasureScript:] | Str = [MeasureScript]").
    (Note: Order of values doesn't mater.)
Here's the HTML code that should be put if you actually want to copy paste what I wrote word for word without changing anything

Code: Select all

<li><p><code>return 99, 'Ninety-Nine'</code><br>Provides <em>99</em> as the number value and <em>'Ninety-Nine'</em> as the string value. Usage depends on a Measure's individual binding, the values can also be retrieved using <a href="https://docs.rainmeter.net/manual/variables/section-variables/#MeasureParameters">Measure Section Variables</a> (<b>Example:</b> <code>Text="Num = [MeasureScript:] | Str = [MeasureScript]"</code>).<br>(<b>Note:</b> Order of values doesn't mater.</p></li>
Done... Thanks!
User avatar
Jeff
Posts: 283
Joined: September 3rd, 2018, 11:18 am

Re: Small docs suggestions - Tuple

Post by Jeff »

jsmorley wrote: September 19th, 2022, 10:52 pm Done... Thanks!
Nice, only problem is that I forgot a singular ")" at the end of the Note in the HTML code, good thing you added SilverAzide's fix though
SilverAzide wrote: September 13th, 2022, 2:17 pm (Note: Order of values doesn't matter.)
;-)
Whoops, thanks for that
User avatar
jsmorley
Developer
Posts: 22558
Joined: April 19th, 2009, 11:02 pm
Location: Fort Hunt, Virginia, USA

Re: Small docs suggestions - Tuple

Post by jsmorley »

Jeff wrote: September 20th, 2022, 3:17 pm Nice, only problem is that I forgot a singular ")" at the end of the Note in the HTML code, good thing you added SilverAzide's fix though


Whoops, thanks for that
Fixed...
User avatar
Jeff
Posts: 283
Joined: September 3rd, 2018, 11:18 am

Small docs suggestions - .rmskin Header Image Bit-Depth

Post by Jeff »

Based on this thread, the Skin Installer only accepts 32bit depth .bmps and not 24bit depth ones, should the detail be added in the docs as an addendum to the already requiered size?
Line that needs to modified is this one: https://github.com/rainmeter/rainmeter-docs/blob/47349bde1d4ab26e59d236568651db08ad1b1f5e/source/manual/distributing-skins/index.html#L93
I would suggest The image must be a bitmap image (.bmp) that is exactly 400x60 pixels in size and has 32bit depth color., but I'm not sure how sound it is.
User avatar
SilverAzide
Rainmeter Sage
Posts: 2250
Joined: March 23rd, 2015, 5:26 pm

Re: Small docs suggestions - .rmskin Header Image Bit-Depth

Post by SilverAzide »

Jeff wrote: November 25th, 2022, 3:28 pm Based on this thread, the Skin Installer only accepts 32bit depth .bmps and not 24bit depth ones, should the detail be added in the docs as an addendum to the already requiered size?
Line that needs to modified is this one: https://github.com/rainmeter/rainmeter-docs/blob/47349bde1d4ab26e59d236568651db08ad1b1f5e/source/manual/distributing-skins/index.html#L93
I would suggest The image must be a bitmap image (.bmp) that is exactly 400x60 pixels in size and has 32bit depth color., but I'm not sure how sound it is.
Better let that thread play out before someone starts changing the manual...
Gadgets Wiki GitHub More Gadgets...
User avatar
Brian
Developer
Posts: 2562
Joined: November 24th, 2011, 1:42 am
Location: Utah

Re: Small docs suggestions

Post by Brian »

SilverAzide wrote: November 25th, 2022, 4:56 pm Better let that thread play out before someone starts changing the manual...
Right. 24-bit bitmap images are fine...ImageMagick must be doing something non-standard.

-Brian
User avatar
Jeff
Posts: 283
Joined: September 3rd, 2018, 11:18 am

Re: Small docs suggestions

Post by Jeff »

These next suggestion are gonna show how bored I am

1. The Version History page is missing the Developers hyperlink from the bottom of the side list, <li><a href="/developers/">Developers</a> should be added between Line 49 and 50 here

2. Options not edited by Rainmeter when switching layouts are now more bountiful, a little more have been added with time, by looking at the code, the list should now be

Code: Select all

<li>ConfigEditor</li>
<li>DisableAutoUpdate</li>
<li>DisableRDP</li>
<li>DisableVersionCheck</li>
<li>HardwareAcceleration</li>
<li>Language</li>
<li>Logging</li>
<li>NetInSpeed</li>
<li>NetOutSpeed</li>
<li>NormalStayDesktop</li>
<li>SelectedColor</li>
<li>SkinPath</li>
<li>TrayExecuteM, TrayExecuteR, TrayExecuteDM, TrayExecuteDR</li>
and should be changed over here (though I suggest the list should be edited to remove it's complexity, only the ones that a monkey can understand is enough)

By proxy, sections in Rainmeter.data ([Favourites], [WebParser]) don't get changed too with the layout, but those files are separate from Rainmeter.ini, which is what this section and file indicates. There's also some options that get saved with the file when you save a layout, but don't move over when you load another layout, like [TrayMeasure] and DesktopWorkArea, I think we can let DesktopWorkArea freeze in a Russian cave atop a mountain though, just, forget about it, let it slowly decompose...
...
...
...
Also what the hell is NormalStayDesktop and DisableRDP?

EDIT: Found out what DisableRDP is, someone on the forum wanted Rainmeter to stop redrawing meters while they were in a remote session, it still exists in today's code and if FUR10N still uses this feature, we should probably not remove it.
User avatar
Brian
Developer
Posts: 2562
Joined: November 24th, 2011, 1:42 am
Location: Utah

Re: Small docs suggestions

Post by Brian »

Thanks for the suggestions. They seem reasonable. We will look into the changes.
Jeff wrote: December 12th, 2022, 7:27 pm NormalStayDesktop
NormalStayDesktop was introduced with Rainmeter version 2.2.0.1037 clear back in 2011. The default value is: NormalStayDesktop=1

Here is the committed code: https://github.com/rainmeter/rainmeter/commit/8cb0a041e04a83151fc95fda4aa945fc90a306d0

I believe the purpose of this option was to keep the skins on the desktop (in their correct z order) when the "Show desktop" button was clicked. Before this change, clicking the "Show Desktop" button would result in the skins disappearing like regular windows and the z order was get scrambled.

We'll look into adding this to the documentation for completeness.

-Brian
User avatar
Jeff
Posts: 283
Joined: September 3rd, 2018, 11:18 am

Re: Small docs suggestions

Post by Jeff »

https://docs.rainmeter.net/manual/meters/string/#StringAlign

I was looking at the StringAlign options I was thinking, this could really benefit from some form of visual guide, similar to the ones present on the Shape page on sections like these
So I made one!
Image

But I don't think the image is enough of an example to show what the options can actually do, how can a user understand how the anchor points look inside an actual skin, so I made an entire guide for an example skin, sadly the image is really big, so here's a link to it
https://i.imgur.com/1kMqnYk.png

I will share the .svg files if necesary/wanted/needed/nice to have.
Last edited by Jeff on January 6th, 2023, 4:02 pm, edited 1 time in total.
User avatar
SilverAzide
Rainmeter Sage
Posts: 2250
Joined: March 23rd, 2015, 5:26 pm

Re: Small docs suggestions

Post by SilverAzide »

Jeff wrote: December 31st, 2022, 2:48 am https://docs.rainmeter.net/manual/meters/string/#StringAlign

I was looking at the StringAlign options I was thinking, this could really benefit from some form of visual guide, similar to the ones present on the Shape page on sections like these
So I made one!
https://i.imgur.com/8D1vU4I.png

But I don't think the image is enough of an example to show what the options can actually do, how can a user understand how the anchor points look inside an actual skin, so I made an entire guide for an example skin, sadly the image is really big, so here's a link to it
https://i.imgur.com/1kMqnYk.png

I will share the .svg files if necesary/wanted/needed/nice to have.
I would think the "centers" should be in the center; i.e., LeftTop | CenterTop | RrightTop; then LeftCenter | CenterCenter | RightCenter, etc.
Gadgets Wiki GitHub More Gadgets...