Updated the manuals

This commit is contained in:
Markus Fleschutz
2024-03-27 17:36:59 +01:00
parent c5b5cb1c6e
commit aed2b7d940
610 changed files with 1754 additions and 1120 deletions

View File

@ -1,15 +1,15 @@
Script: *what-is.ps1*
========================
This PowerShell script queries the meaning of the given abbreviation and prints it.
This PowerShell script queries the meaning of the given term/abbreviation/etc. and prints it.
Parameters
----------
```powershell
PS> ./what-is.ps1 [[-abbr] <String>] [<CommonParameters>]
PS> ./what-is.ps1 [[-term] <String>] [<CommonParameters>]
-abbr <String>
Specifies the abbreviation to query
-term <String>
Specifies the term to query
Required? false
Position? 1
@ -43,11 +43,11 @@ Script Content
```powershell
<#
.SYNOPSIS
Explains an abbreviation
Explains a term/abbreviation/etc.
.DESCRIPTION
This PowerShell script queries the meaning of the given abbreviation and prints it.
.PARAMETER abbr
Specifies the abbreviation to query
This PowerShell script queries the meaning of the given term/abbreviation/etc. and prints it.
.PARAMETER term
Specifies the term to query
.EXAMPLE
PS> ./what-is VTOL
💡 VTOL in aviation refers to Vertical Take-Off and Landing
@ -57,21 +57,21 @@ Script Content
Author: Markus Fleschutz | License: CC0
#>
param([string]$abbr = "")
param([string]$term = "")
try {
if ($abbr -eq "" ) { $abbr = Read-Host "Enter the abbreviation to query" }
$files = (Get-ChildItem "$PSScriptRoot/../data/abbr/*.csv")
if ($term -eq "" ) { $term = Read-Host "Enter the term/abbreviation/etc. to query" }
$files = (Get-ChildItem "$PSScriptRoot/../data/dicts/*.csv")
$basename = ""
foreach($file in $files) {
$table = Import-CSV "$file"
foreach($row in $table) {
if ($row.ABBR -ne $abbr) { continue }
if ($row.TERM -ne $term) { continue }
$basename = (Get-Item "$file").Basename -Replace "_"," "
"💡 $($row.ABBR) in $basename refers to $($row.MEANING)"
"💡 $($row.TERM) in $basename refers to: $($row.MEANING)"
}
}
if ($basename -eq "") { "🤷‍ Sorry, no '$abbr' entry found. Use <Ctrl> <Click> to google it: https://www.google.com/search?q=abbreviation+$abbr" }
if ($basename -eq "") { "🤷‍ Sorry, no '$term' entry found. Use <Ctrl> <Click> to google it: https://www.google.com/search?q=what+is+$term" }
exit 0 # success
} catch {
"⚠️ Error in line $($_.InvocationInfo.ScriptLineNumber): $($Error[0])"
@ -79,4 +79,4 @@ try {
}
```
*(generated by convert-ps2md.ps1 using the comment-based help of what-is.ps1 as of 01/25/2024 13:58:43)*
*(generated by convert-ps2md.ps1 using the comment-based help of what-is.ps1 as of 03/27/2024 17:36:32)*