mirror of
https://github.com/fleschutz/PowerShell.git
synced 2025-08-10 21:33:47 +02:00
Updated the Markdown manuals
This commit is contained in:
79
docs/write-centered.md
Normal file
79
docs/write-centered.md
Normal file
@ -0,0 +1,79 @@
|
||||
Script: *write-centered.ps1*
|
||||
========================
|
||||
|
||||
This PowerShell script writes the given text centered to the console.
|
||||
|
||||
Parameters
|
||||
----------
|
||||
```powershell
|
||||
PS> ./write-centered.ps1 [[-text] <String>] [<CommonParameters>]
|
||||
|
||||
-text <String>
|
||||
Specifies the text to write
|
||||
|
||||
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.
|
||||
```
|
||||
|
||||
Example
|
||||
-------
|
||||
```powershell
|
||||
PS> ./write-headline.ps1 "Hello World"
|
||||
Hello World
|
||||
|
||||
```
|
||||
|
||||
Notes
|
||||
-----
|
||||
Author: Markus Fleschutz | License: CC0
|
||||
|
||||
Related Links
|
||||
-------------
|
||||
https://github.com/fleschutz/PowerShell
|
||||
|
||||
Script Content
|
||||
--------------
|
||||
```powershell
|
||||
<#
|
||||
.SYNOPSIS
|
||||
Writes text centered
|
||||
.DESCRIPTION
|
||||
This PowerShell script writes the given text centered to the console.
|
||||
.PARAMETER text
|
||||
Specifies the text to write
|
||||
.EXAMPLE
|
||||
PS> ./write-headline.ps1 "Hello World"
|
||||
Hello World
|
||||
.LINK
|
||||
https://github.com/fleschutz/PowerShell
|
||||
.NOTES
|
||||
Author: Markus Fleschutz | License: CC0
|
||||
#>
|
||||
|
||||
param([string]$text = "")
|
||||
|
||||
try {
|
||||
if ($text -eq "") { $text = Read-Host "Enter the text to write" }
|
||||
|
||||
$ui = (Get-Host).ui
|
||||
$rui = $ui.rawui
|
||||
[int]$numSpaces = ($rui.MaxWindowSize.Width - $text.Length) / 2
|
||||
|
||||
[string]$spaces = ""
|
||||
for ([int]$i = 0; $i -lt $numSpaces; $i++) { $spaces += " " }
|
||||
Write-Host "$spaces$text"
|
||||
exit 0 # success
|
||||
} catch {
|
||||
"⚠️ Error in line $($_.InvocationInfo.ScriptLineNumber): $($Error[0])"
|
||||
exit 1
|
||||
}
|
||||
```
|
||||
|
||||
*(generated by convert-ps2md.ps1 using the comment-based help of write-centered.ps1 as of 05/19/2024 10:25:27)*
|
Reference in New Issue
Block a user