It is currently October 24th, 2021, 9:57 am

Small docs suggestions

Discussion about the documentation, main Rainmeter site and forums.
User avatar
Jeff
Posts: 232
Joined: September 3rd, 2018, 11:18 am

Re: Small docs suggestions

Post by Jeff »

https://docs.rainmeter.net/manual/plugins/usagemonitor/
Both instances of %Processor Time (at the top and Counter=% Processor Time) are inncorect, % Processor Time (with a space) is the correct one (found this out by copy pasting from the counter one and the Rainmeter log crying out loud)
Unrelated to the docs but for some reason the error that spews out when you type the counter wrong has the debug notice of what I would assume should be a error notice?
User avatar
jsmorley
Developer
Posts: 22374
Joined: April 19th, 2009, 11:02 pm
Location: Fort Hunt, Virginia, USA

Re: Small docs suggestions

Post by jsmorley »

Jeff wrote: February 8th, 2021, 3:35 pm https://docs.rainmeter.net/manual/plugins/usagemonitor/
Both instances of %Processor Time (at the top and Counter=% Processor Time) are inncorect, % Processor Time (with a space) is the correct one (found this out by copy pasting from the counter one and the Rainmeter log crying out loud)
Unrelated to the docs but for some reason the error that spews out when you type the counter wrong has the debug notice of what I would assume should be a error notice?
Those typos are fixed. Thanks for reporting.
User avatar
Jeff
Posts: 232
Joined: September 3rd, 2018, 11:18 am

Re: Small docs suggestions

Post by Jeff »

Read the tutorials because I was bored, I have only two small suggestions:

1. https://docs.rainmeter.net/manual/getting-started/basic-tutorials/
This series is in development. Check back soon for the first installment.
* I feel like someone forgot to remove it or there was probably no willpower to add more tutorials, seems like the text has been there for 9 years now.

2. https://docs.rainmeter.net/manual/getting-started/basic-tutorials/launcher/
* The first paragraph starting with a lowercase L (dosen't really matter)
* The second paragraph encourages using Windows Explorer, maybe it would be of better interest forcing the user to familiarize themselves with the Create new skin menu
* Ironically, the clocks tutorial has the same paragraph copy pasted (minus the part about creating the Tutorials folder in the Skins folder) and what's there sounds like a good second option (for example, the new section would encourage using the Create new Skins section and the second part of it is just copy pasted from what's currently there)
User avatar
Brian
Developer
Posts: 2272
Joined: November 24th, 2011, 1:42 am
Location: Utah

Re: Small docs suggestions

Post by Brian »

Jeff wrote: May 7th, 2021, 2:20 pm 1. https://docs.rainmeter.net/manual/getting-started/basic-tutorials/
This series is in development. Check back soon for the first installment.
* I feel like someone forgot to remove it or there was probably no willpower to add more tutorials, seems like the text has been there for 9 years now.
I think you are right on both accounts. We planned on adding more examples, but at the time we focused on completing the rest of the docs. We quickly got burned out.

I think we will leave this for now since we may come back to it ... (or maybe someone would like to submit a PR with new tutorials) :D
Jeff wrote: May 7th, 2021, 2:20 pm 2. https://docs.rainmeter.net/manual/getting-started/basic-tutorials/launcher/
* The first paragraph starting with a lowercase L (dosen't really matter)
* The second paragraph encourages using Windows Explorer, maybe it would be of better interest forcing the user to familiarize themselves with the Create new skin menu
* Ironically, the clocks tutorial has the same paragraph copy pasted (minus the part about creating the Tutorials folder in the Skins folder) and what's there sounds like a good second option (for example, the new section would encourage using the Create new Skins section and the second part of it is just copy pasted from what's currently there)
Fixed the lowercase typo. Thank you!

As to using the Create new skin dialog, I am not sure it is the place for this. These tutorials are trying to be as basic as possible that most people can follow. I think the Create new skin function is a little more than basic for a first time user especially the "template" stuff. To me, the goal is to bridge what a user probably already knows (like creating files/folders) and then diving right in on creating a workable skin.

Having said that, we could improve on this. Maybe what is needed is a separate generic "Create a new skin" tutorial, that could show both the Create new skin method and the Windows explorer method.

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

Re: Small docs suggestions

Post by Jeff »

Brian wrote: May 7th, 2021, 11:56 pm I think we will leave this for now since we may come back to it ... (or maybe someone would like to submit a PR with new tutorials) :D
-Brian
I wish I was more fluent in English, else I would share all kind of propaganda like MODULAR METERSTYLE PROPAGANDA

Code: Select all

[Rainmeter]
Update=-1
[Variables]
Icon0="#@#Move.png"
Icon1="#@#Calculator.png"
Icon2="#@#Install.png"
Icon3="#@#Firefox.png"

Action0=[]
Action1=["Calc.exe"]
Action2=["SkinInstaller.exe"]
Action3=["Firefox.exe"]

ToolTipText0="Move"
ToolTipText1="Calculator"
ToolTipText2="Install a skin"
ToolTipText3="Firefox"

[Style]
ImageName=[#Icon[#CURRENTSECTION]]
ImageAlpha=127
LeftMouseUpAction=[#Action[#CURRENTSECTION]]
MouseOverAction =[!SetOption #CURRENTSECTION# ImageAlpha 255]
MouseLeaveAction=[!SetOption #CURRENTSECTION# ImageAlpha 127]
ToolTipText=[#ToolTipText[#CURRENTSECTION]]
W=60
H=60
X=20R
Y=r

[0]
Meter=Image
MeterStyle=Style
X=10r
Y=10
[1]
Meter=Image
MeterStyle=Style
[2]
Meter=Image
MeterStyle=Style
[3]
Meter=Image
MeterStyle=Style
or getting users familiar with how new variables are always dynamic in bangs so on an Update=-1 skin you can do something like

Code: Select all

LeftMouseUpAction=[!WriteKeyValue Variables "Toggle#CURRENTSECTION#" "(1-[#Toggle#CURRENTSECTION#])"][!SetVariable "Toggle#CURRENTSECTION#" "(1- [#Toggle#CURRENTSECTION#])"][!Update]
(let's call this DYNAMIC BANG PROPAGANDA)

orrrrrrr...
*opens random file i have on pc to call propaganda*

or some really easy yet useful thing like UPTIME PROPAGANDA

Code: Select all

[Birth]
Measure=Time
Format=%Y-%m-%dT%H:%M:%SZ
TimeStamp=2001-01-18T21:00:00Z
TimeStampFormat=%Y-%m-%dT%H:%M:%SZ
[DeathPlus80]
Measure=Calc
Formula=Birth + 80
[Death]
Measure=Time
Format=%Y-%m-%dT%H:%M:%SZ
TimeStamp=[DeathPlus80]-01-18T21:00:00Z
TimeStampFormat=%Y-%m-%dT%H:%M:%SZ
DynamicVariables=1
[Current]
Measure=Time
[CurrentTimestamp]
Measure=String
String=[Current:timestamp]
MinValue=[Birth:timestamp]
MaxValue=[Death:timestamp]
DynamicVariables=1
[Bar]
Meter=Bar
MeasureName=CurrentTimestamp
(this just counts the time untill death)
User avatar
Jeff
Posts: 232
Joined: September 3rd, 2018, 11:18 am

Re: Small docs suggestions

Post by Jeff »

Because Windows is murdering the wmic command line in cold blood and hiding the body at night, this line will need to be changed to what jsmorley gave as an example or something else
User avatar
jsmorley
Developer
Posts: 22374
Joined: April 19th, 2009, 11:02 pm
Location: Fort Hunt, Virginia, USA

Re: Small docs suggestions

Post by jsmorley »

Jeff wrote: May 26th, 2021, 9:22 am Because Windows is murdering the wmic command line in cold blood and hiding the body at night, this line will need to be changed to what jsmorley gave as an example or something else
Done... Thanks!

https://docs.rainmeter.net/manual-beta/plugins/runcommand
User avatar
Jeff
Posts: 232
Joined: September 3rd, 2018, 11:18 am

Re: Small docs suggestions

Post by Jeff »

Well it's not specifically the line I referenced in the previous post but it's better that the copy paste example got updated (it's probably the first thing anyone will try when looking at the measure for the first time). Good job!
I don't think Powershell's Execution Policy thing will affect it with anything.

(Commit for the curious since it was hard for me to recognize the changed lines)
User avatar
Jeff
Posts: 232
Joined: September 3rd, 2018, 11:18 am

Re: Small docs suggestions

Post by Jeff »

https://docs.rainmeter.net/manual/skins/rainmeter-section/defaults/
The Default Settings section has disappeared from under the [Rainmeter] section button

While I'm on it, there should be a hyperlink to the Default Settings page on https://docs.rainmeter.net/manual/settings/skin-sections/ saying something like "These settings can be changed when you first run a skin using Default Settings" and maybe a section on https://docs.rainmeter.net/manual/skins/rainmeter-section/ saying that the section allows you to add options that change config parameters on first run.
User avatar
jsmorley
Developer
Posts: 22374
Joined: April 19th, 2009, 11:02 pm
Location: Fort Hunt, Virginia, USA

Re: Small docs suggestions

Post by jsmorley »

Jeff wrote: August 27th, 2021, 9:46 am https://docs.rainmeter.net/manual/skins/rainmeter-section/defaults/
The Default Settings section has disappeared from under the [Rainmeter] section button
Fixed. Thanks for reporting.

I'll have to chew on the other suggestion(s). I'm hesitant to confuse people about where these default settings are actually set.