PScribo
3par-powershell
activedirectory
activedirectory_filter
activedirectory_identity
activedirectory_objectmodel
activitycommonparameters
aliases
arithmetic_operators
arrays
assignment_operators
automatic_variables
beforeeach_aftereach
binshred
break
carbon
carbon_2.0
carbon_contributing
carbon_extended_type_data
carbon_installation
carbon_support
ceip
checkpoint-workflow
cimsession
classes
command_precedence
command_syntax
comment_based_help
commonparameters
comparison_operators
configuration
continue
core_commands
data_sections
debuggers
desiredstateconfiguration
do
document
environment_variables
escape_characters
eventlogs
execution_policies
for
foreach-parallel
foreach
format.ps1xml
functions
functions_advanced
functions_advanced_methods
functions_advanced_parameters
functions_cmdletbindingattribute
functions_outputtypeattribute
group_policy_settings
hash_tables
history
if
inlinescript
invalid_certificates
job_details
jobs
join
language_keywords
language_modes
line_editing
locations
logical_operators
methods
mocking
modules
object_creation
objects
obn
operator_precedence
operators
packagemanagement
parallel
parameters
parameters_default_values
parsing
parsing_loctest
path_syntax
pester
pipelines
plaster.help
plaster_creatingamanifest.help
platyps
plugins
poshrsjob
powercli_objects
powershell.exe
powershell_ise.exe
powershelllogging
preference_variables
profiles
prompts
properties
providers
psconsolehostreadline
pscribo
pscx
psreadline
psscriptanalyzer
pssession_details
pssessions
pssnapins
psversioncompare
quoting_rules
redirection
ref
regular_expressions
remote
remote_disconnected_sessions
remote_faq
remote_jobs
remote_output
remote_requirements
remote_troubleshooting
remote_variables
requires
reserved_words
return
run_with_powershell
runasync
scheduled_jobs
scheduled_jobs_advanced
scheduled_jobs_basics
scheduled_jobs_troubleshooting
scopes
script_blocks
script_internationalization
scripts
sequence
server_authentication
session_configuration_files
session_configurations
should
signing
spaccessserviceapp
spalternateurl
spantivirussettings
spappcatalog
spappdomain
spappmanagementserviceapp
spappstoresettings
spbcsserviceapp
spblobcachesettings
spcacheaccounts
spconfigwizard
spcontentdatabase
spcreatefarm
spdatabaseaag
spdesignersettings
spdiagnosticloggingsettings
spdistributedcacheservice
special_characters
spexcelserviceapp
spfarmadministrators
spfarmsolution
spfeature
sphealthanalyzerrulestate
spinstall
spinstalllanguagepack
spinstallprereqs
spirmsettings
spjoinfarm
splatting
split
spmanagedaccount
spmanagedmetadataserviceapp
spmanagedpath
spofficeonlineserverbinding
spoutgoingemailsettings
sppasswordchangesettings
spperformancepointserviceapp
spproductupdate
sppublishserviceapplication
spquotatemplate
spremotefarmtrust
spsearchcontentsource
spsearchcrawlrule
spsearchfiletype
spsearchindexpartition
spsearchresultsource
spsearchserviceapp
spsearchtopology
spsecurestoreserviceapp
spserviceapppool
spserviceappproxygroup
spserviceappsecurity
spserviceinstance
spsessionstateservice
spshelladmins
spsite
spstateserviceapp
spsubscriptionsettingsserviceapp
sptimerjobstate
sptrustedidentitytokenissuer
spusageapplication
spuserprofileproperty
spuserprofilesection
spuserprofileserviceapp
spuserprofileserviceapppermissions
spuserprofilesyncconnection
spuserprofilesyncservice
spvisioserviceapp
spweb
spwebappblockedfiletypes
spwebappgeneralsettings
spwebapplication
spwebapplicationappdomain
spwebapppermissions
spwebapppolicy
spwebappproxygroup
spwebappsiteuseanddeletion
spwebappthrottlingsettings
spwebappworkflowsettings
spwordautomationserviceapp
spworkmanagementserviceapp
suspend-workflow
switch
testdrive
throw
transactions
trap
try_catch_finally
type_operators
types.ps1xml
uid
updatable_help
variables
vimdatastore
while
wildcards
windows_powershell_5.0
windows_powershell_ise
windows_rt
wmi
wmi_cmdlets
workflowcommonparameters
workflows
wql
ws-management_cmdlets
activedirectory
activedirectory_filter
activedirectory_identity
activedirectory_objectmodel
activitycommonparameters
aliases
arithmetic_operators
arrays
assignment_operators
automatic_variables
beforeeach_aftereach
binshred
break
carbon
carbon_2.0
carbon_contributing
carbon_extended_type_data
carbon_installation
carbon_support
ceip
checkpoint-workflow
cimsession
classes
command_precedence
command_syntax
comment_based_help
commonparameters
comparison_operators
configuration
continue
core_commands
data_sections
debuggers
desiredstateconfiguration
do
document
environment_variables
escape_characters
eventlogs
execution_policies
for
foreach-parallel
foreach
format.ps1xml
functions
functions_advanced
functions_advanced_methods
functions_advanced_parameters
functions_cmdletbindingattribute
functions_outputtypeattribute
group_policy_settings
hash_tables
history
if
inlinescript
invalid_certificates
job_details
jobs
join
language_keywords
language_modes
line_editing
locations
logical_operators
methods
mocking
modules
object_creation
objects
obn
operator_precedence
operators
packagemanagement
parallel
parameters
parameters_default_values
parsing
parsing_loctest
path_syntax
pester
pipelines
plaster.help
plaster_creatingamanifest.help
platyps
plugins
poshrsjob
powercli_objects
powershell.exe
powershell_ise.exe
powershelllogging
preference_variables
profiles
prompts
properties
providers
psconsolehostreadline
pscribo
pscx
psreadline
psscriptanalyzer
pssession_details
pssessions
pssnapins
psversioncompare
quoting_rules
redirection
ref
regular_expressions
remote
remote_disconnected_sessions
remote_faq
remote_jobs
remote_output
remote_requirements
remote_troubleshooting
remote_variables
requires
reserved_words
return
run_with_powershell
runasync
scheduled_jobs
scheduled_jobs_advanced
scheduled_jobs_basics
scheduled_jobs_troubleshooting
scopes
script_blocks
script_internationalization
scripts
sequence
server_authentication
session_configuration_files
session_configurations
should
signing
spaccessserviceapp
spalternateurl
spantivirussettings
spappcatalog
spappdomain
spappmanagementserviceapp
spappstoresettings
spbcsserviceapp
spblobcachesettings
spcacheaccounts
spconfigwizard
spcontentdatabase
spcreatefarm
spdatabaseaag
spdesignersettings
spdiagnosticloggingsettings
spdistributedcacheservice
special_characters
spexcelserviceapp
spfarmadministrators
spfarmsolution
spfeature
sphealthanalyzerrulestate
spinstall
spinstalllanguagepack
spinstallprereqs
spirmsettings
spjoinfarm
splatting
split
spmanagedaccount
spmanagedmetadataserviceapp
spmanagedpath
spofficeonlineserverbinding
spoutgoingemailsettings
sppasswordchangesettings
spperformancepointserviceapp
spproductupdate
sppublishserviceapplication
spquotatemplate
spremotefarmtrust
spsearchcontentsource
spsearchcrawlrule
spsearchfiletype
spsearchindexpartition
spsearchresultsource
spsearchserviceapp
spsearchtopology
spsecurestoreserviceapp
spserviceapppool
spserviceappproxygroup
spserviceappsecurity
spserviceinstance
spsessionstateservice
spshelladmins
spsite
spstateserviceapp
spsubscriptionsettingsserviceapp
sptimerjobstate
sptrustedidentitytokenissuer
spusageapplication
spuserprofileproperty
spuserprofilesection
spuserprofileserviceapp
spuserprofileserviceapppermissions
spuserprofilesyncconnection
spuserprofilesyncservice
spvisioserviceapp
spweb
spwebappblockedfiletypes
spwebappgeneralsettings
spwebapplication
spwebapplicationappdomain
spwebapppermissions
spwebapppolicy
spwebappproxygroup
spwebappsiteuseanddeletion
spwebappthrottlingsettings
spwebappworkflowsettings
spwordautomationserviceapp
spworkmanagementserviceapp
suspend-workflow
switch
testdrive
throw
transactions
trap
try_catch_finally
type_operators
types.ps1xml
uid
updatable_help
variables
vimdatastore
while
wildcards
windows_powershell_5.0
windows_powershell_ise
windows_rt
wmi
wmi_cmdlets
workflowcommonparameters
workflows
wql
ws-management_cmdlets
Pscribo
PScribo
about_Styles
about_Tables
about_Plugins
SYNOPSIS
PScribo is a documentation framework for PowerShell.
DESCRIPTION
PScribo is an open source project that implements a documentation
domain-specific-language (DSL) for Windows Powershell. The latest version is
available at https://github.com/iainbrighton/PScribo.
PScribo provides a set of functions that make it easy to create a document-like
structure within Powershell without having to handle individual output formatting.
A document's layout and contents only need to defined once. After report creation,
the document can be exported to one or more formats simultaneously. For more detailed
infomation on the documentation DSL, see about_Document. Pscribo can export
documentation in a variety of formats and currently supports creation of text, xml
and html formats. Additional "plugins" can be created to support future formats if
required. For more detailed information on creating a "plugin" see about_Plugins.
PScribo is available as a Powershell module or a bundle. The bundle permits
dot-sourcing the PScribo bundle file or can be placed in its entirety at the
beginning of an existing .ps1 file.
CREATING A PSCRIBO DOCUMENT
To start using PScribo, you need to either install the PScribo module in your
Powershell module path or download the PScribo bundle. OTHER EXAMPLES Included in the
PScribo module (not the bundle) are some heavily documented example scripts in the
.\Examples directory.
SEE ALSO
about_Documentabout_Styles
about_Tables
about_Plugins
Document GlobalOption *Header *Footer Style TableStyle Section Paragraph Table PageBreak LineBreak