PowerShell/docs/write-headline.md

Script: *write-headline.ps1*
========================

This PowerShell script writes the given text as a headline.

Parameters
----------
```powershell
PS> ./write-headline.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 a headline
.DESCRIPTION
	This PowerShell script writes the given text as a headline.
.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" }

	Write-Host "`n* $text *" -foregroundColor green
	[int]$len = $text.Length
	[string]$line = "----"
	for ([int]$i = 0; $i -lt $len; $i++) { $line += "-" }
	Write-Host "$line" -foregroundColor green
	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-headline.ps1 as of 05/19/2024 10:25:27)*