PowerShell/docs/what-is.md

83 lines
2.0 KiB
Markdown
Raw Normal View History

2023-07-29 10:34:04 +02:00
*what-is.ps1*
================
2021-11-08 21:36:42 +01:00
2023-09-01 17:53:03 +02:00
This PowerShell script queries the meaning of the given abbreviation and prints it.
2021-11-08 21:36:42 +01:00
2023-07-29 10:04:38 +02:00
Parameters
----------
2021-11-08 21:36:42 +01:00
```powershell
2023-07-29 10:15:44 +02:00
PS> ./what-is.ps1 [[-abbr] <String>] [<CommonParameters>]
2021-11-08 21:36:42 +01:00
2023-05-26 12:20:18 +02:00
-abbr <String>
2023-09-01 17:53:03 +02:00
Specifies the abbreviation to query
2021-11-08 21:36:42 +01:00
Required? false
Position? 1
Default value
Accept pipeline input? false
Accept wildcard characters? false
[<CommonParameters>]
This script supports the common parameters: Verbose, Debug, ErrorAction, ErrorVariable, WarningAction,
WarningVariable, OutBuffer, PipelineVariable, and OutVariable.
```
2023-07-29 10:04:38 +02:00
Example
-------
2021-11-08 21:36:42 +01:00
```powershell
2023-09-01 17:53:03 +02:00
PS> ./what-is VTOL
2023-10-19 08:12:00 +02:00
💡 VTOL in aviation refers to Vertical Take-Off and Landing
2021-11-08 21:36:42 +01:00
```
2023-07-29 10:04:38 +02:00
Notes
-----
2022-11-17 19:46:02 +01:00
Author: Markus Fleschutz | License: CC0
2021-11-08 21:36:42 +01:00
2023-07-29 10:04:38 +02:00
Related Links
-------------
2021-11-08 21:36:42 +01:00
https://github.com/fleschutz/PowerShell
2023-07-29 10:04:38 +02:00
Script Content
--------------
2022-11-17 20:05:34 +01:00
```powershell
2022-11-17 20:02:26 +01:00
<#
.SYNOPSIS
2023-05-26 12:20:18 +02:00
Explains an abbreviation
2022-11-17 20:02:26 +01:00
.DESCRIPTION
2023-09-01 17:53:03 +02:00
This PowerShell script queries the meaning of the given abbreviation and prints it.
2023-05-26 12:20:18 +02:00
.PARAMETER abbr
2023-09-01 17:53:03 +02:00
Specifies the abbreviation to query
2022-11-17 20:02:26 +01:00
.EXAMPLE
2023-09-01 17:53:03 +02:00
PS> ./what-is VTOL
2023-10-19 08:12:00 +02:00
💡 VTOL in aviation refers to Vertical Take-Off and Landing
2022-11-17 20:02:26 +01:00
.LINK
https://github.com/fleschutz/PowerShell
.NOTES
Author: Markus Fleschutz | License: CC0
#>
2023-05-26 12:20:18 +02:00
param([string]$abbr = "")
2022-11-17 20:02:26 +01:00
try {
2023-09-01 17:53:03 +02:00
if ($abbr -eq "" ) { $abbr = Read-Host "Enter the abbreviation to query" }
$files = (Get-ChildItem "$PSScriptRoot/../Data/Abbr/*.csv")
$basename = ""
foreach($file in $files) {
$table = Import-CSV "$file"
foreach($row in $table) {
if ($row.ABBR -ne $abbr) { continue }
$basename = (Get-Item "$file").Basename -Replace "_"," "
2023-10-19 08:12:00 +02:00
"💡 $($row.ABBR) in $basename refers to $($row.MEANING)"
2022-11-17 20:02:26 +01:00
}
}
2023-10-19 08:12:00 +02:00
if ($basename -eq "") { "🤷‍ Sorry, no entry '$abbr' in my database (located at .../Data/Abbr/)." }
2022-11-17 20:02:26 +01:00
exit 0 # success
} catch {
"⚠️ Error in line $($_.InvocationInfo.ScriptLineNumber): $($Error[0])"
exit 1
}
2022-11-17 20:05:34 +01:00
```
2022-11-17 20:02:26 +01:00
2023-10-19 08:12:00 +02:00
*(generated by convert-ps2md.ps1 using the comment-based help of what-is.ps1 as of 10/19/2023 08:11:43)*