-
-
Notifications
You must be signed in to change notification settings - Fork 18
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
6456fc4
commit 38ccd83
Showing
24 changed files
with
555 additions
and
49 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Binary file not shown.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,13 @@ | ||
| # Module Functions | ||
|
|
||
| This section contains the same help content you would get from a PowerShell prompt using `Get-Help`. Note that most code examples have been formatted to fit the 80 character page width and sometimes with artificial formatting. Don't assume you can run examples _exactly_ as they are shown. Some of the help examples might also use special or custom characters that might not render properly in the PDF. | ||
|
|
||
| If you can't remember what commands are in this module, you can always ask PowerShell. | ||
|
|
||
| ```powershell | ||
| Get-Command -module ADReportingTools | ||
| ``` | ||
|
|
||
| Or use the `Get-PSScriptTools` command. | ||
|
|
||
|  |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,200 @@ | ||
| #requires -version 7.1 | ||
|
|
||
| [cmdletbinding(SupportsShouldProcess)] | ||
| Param( | ||
| [Parameter(Position = 0)] | ||
| [ValidateNotNullOrEmpty()] | ||
| [ValidateScript({Test-Path $_})] | ||
| [string]$Path = ".", | ||
| [Parameter(HelpMessage = "The path to a json file with the processing data for the folder.")] | ||
| [ValidateNotNullOrEmpty()] | ||
| [ValidateScript( {Test-Path $_})] | ||
| [string]$DataPath = ".\adoc-data.json" | ||
| ) | ||
|
|
||
| $prog = @{ | ||
| Activity = "Prepare ADOC files" | ||
| Status = "Initializing" | ||
| CurrentOperation = "" | ||
| PercentComplete = 0 | ||
| } | ||
|
|
||
| Write-Progress @prog | ||
|
|
||
| $ModulePath = Convert-Path $Path | ||
| $moduleName = Split-Path $modulePath -leaf | ||
| Write-Verbose "[$(Get-Date)] Working from $modulePath" | ||
|
|
||
| Write-Verbose "[$(Get-Date)] Importing ruby-related functions" | ||
| . C:\scripts\rubydocs.ps1 | ||
|
|
||
| Write-Verbose "[$(Get-Date)] Importing adoc data from json" | ||
| <# | ||
| { | ||
| "Name" : "PSScriptToolsManual", | ||
| "Title": "PSScriptTools Manual", | ||
| "CodeTheme": "githubcustom", | ||
| "CodeThemePath": "c:\\scripts\\githubcustom.rb", | ||
| "Theme": "pdf-theme.yml", | ||
| "Files": [ | ||
| { | ||
| "Name": "Intro.md", | ||
| "Lines": "" | ||
| }, | ||
| { | ||
| "Name": "README.md", | ||
| "Lines": "1;13..15;33..-1" | ||
| }, | ||
| { | ||
| "Name": "ModuleCommands.md", | ||
| "Lines": "" | ||
| } | ||
| ] | ||
| }#> | ||
|
|
||
| $data = Get-Content $DataPath | ConvertFrom-Json | ||
|
|
||
| Write-Verbose "[$(Get-Date)] Get the module version" | ||
| $ver = (Test-ModuleManifest -Path .\$modulename.psd1).version.tostring() | ||
| #(Import-PowerShellDataFile $ModulePath\*.psd1).moduleversion | ||
| Write-Verbose "[$(Get-Date)] Found version $ver" | ||
|
|
||
| #update pdf-them.yml with the module version | ||
| Write-Verbose "[$(Get-Date)] Updating book theme yml file" | ||
| New-BookThemeYml -version $ver -title "ADReportingTools Help Manual" -image "images/2PopulatedDomain01.png" | ||
|
|
||
| #define a here-string for the main document in Asciidoctor format | ||
| $Main = @" | ||
| = $($data.title) v$Ver | ||
| :allow-uri-read: | ||
| :autofit-option: | ||
| :data-uri: | ||
| :icons: font | ||
| :iconset: fa | ||
| :linkattrs: | ||
| :rouge-style: $($data.codeTheme) | ||
| :source-highlighter: rouge | ||
| "@ | ||
|
|
||
| $files = $data.files | ||
| $prog.status = "Processing main files" | ||
| $i = 0 | ||
| foreach ($file in $files) { | ||
| $i++ | ||
| $prog.CurrentOperation = $file.name | ||
| $prog.percentComplete = ($i/$files.count)*100 | ||
| Write-Progress @prog | ||
| $item = Join-Path -Path $Modulepath -ChildPath $file.name | ||
| Write-Verbose "[$(Get-Date)] Converting $item" | ||
| Get-Item -path $item | | ||
| ConvertTo-Adoc -Codetheme $data.codeTheme | ||
|
|
||
| $adoc = $item -replace "md", "adoc" | ||
| $c = Get-Content $adoc | ||
|
|
||
| Write-Verbose "[$(Get-Date)] Adjustings links and xrefs" | ||
| [regex]$lx = "xref:(?<link>\S+)\.adoc\[(?<display>((\w+[\s-]\w+))+)\]" | ||
| $matchData = $lx.matches($c) | ||
| foreach ($item in $matchData) { | ||
| $link = $item.groups.where( {$_.name -eq 'link'}).value | ||
| $display = $item.groups.where( {$_.name -eq 'display'}).value | ||
|
|
||
| #split off the command name from the link to build the | ||
| #correct cross-reference in the PDF | ||
| $cmdName = $link.split("/")[-1] | ||
| $xlink = "$cmdName-Help" | ||
| $xref = "<<{0},{1}>>" -f $xlink, $display | ||
| #use the method because the value has regex characters | ||
| $c = $c.replace($item.value, $xref) | ||
| } | ||
|
|
||
| Write-Verbose "[$(Get-Date)] Updating $adoc" | ||
| $c | Out-File -FilePath $adoc -Encoding utf8 | ||
|
|
||
| Write-Verbose "[$(Get-Date)] Adding to Main" | ||
| #include line subsets if defined | ||
| if ($file.lines) { | ||
| $trim = "lines=$($file.lines)" | ||
| } | ||
| else { | ||
| $trim = "" | ||
| } | ||
| $main += @" | ||
| include::$($adoc)[$trim] | ||
| "@ | ||
| } | ||
|
|
||
| Write-Verbose "[$(Get-Date)] Creating adoc help files. You may need to press Enter to force the process to continue." | ||
|
|
||
| #create the adoc files and then edit them. | ||
| $prog.Status = "Converting markdown to adoc files" | ||
| $prog.CurrentOperation = | ||
| $i = 0 | ||
| $helpMD = Get-ChildItem $ModulePath\docs\*-*.md | ||
|
|
||
| $helpmd | ForEach-Object { | ||
| $i++ | ||
| $prog.CurrentOperation = $_.FullName | ||
| $prog.percentComplete = ($i/$helpmd.count)*100 | ||
| Write-Progress @prog | ||
| ConvertTo-Adoc -Fullname $_.fullname -passthru -theme $data.codeTheme | Edit-Adoc | ||
| } | ||
|
|
||
| $prog.status = "Building main document" | ||
| Write-Verbose "[$(Get-Date)] Add include links to the main document" | ||
| $adocs = Get-ChildItem $ModulePath\docs\*.adoc -OutVariable ov | Sort-Object -property Name | ||
|
|
||
| $i = 0 | ||
| ForEach ($item in $adocs) { | ||
| $i++ | ||
| $prog.CurrentOperation = $item.name | ||
| $prog.percentComplete = ($i/$adocs.count)*100 | ||
| Write-Progress @prog | ||
| Write-Verbose "[$(Get-Date)] Adding $($item.name)" | ||
| $main += @" | ||
| include::docs\$($item.name)[] | ||
| "@ | ||
| } | ||
|
|
||
| #Add Changelog | ||
| Write-Verbose "[$(Get-Date)] Adding ChangeLog" | ||
| ConvertTo-Adoc -Fullname $PSScriptRoot\ChangeLog.md -passthru -theme $data.codeTheme | ||
| $log = Join-Path -Path $Modulepath -ChildPath Changelog.adoc | ||
|
|
||
| #convert headings to bold monospace | ||
| $content = Get-Content -path $log | ||
|
|
||
| [regex]$rxVer = "==\s(?<version>v\d+\.\d+\.\d+)" | ||
|
|
||
| $rxver.matches($content) | foreach-Object { | ||
| $Find = $_.value | ||
| $Replace = "``*$($_.groups[1].value)``*" | ||
| Write-Verbose "[$(Get-Date)] Replace '$find' with $Replace" | ||
| $content = $content.replace($Find,$Replace) | ||
| } | ||
|
|
||
| $content | Out-File $log -Encoding utf8 | ||
| $main += @" | ||
| include::$log[] | ||
| "@ | ||
|
|
||
| $out = Join-Path -path $ModulePath -child "$($data.name).adoc" | ||
| $prog.status = "Finalizing" | ||
| $prog.CurrentOperation = $out | ||
| Write-Progress @prog | ||
| Write-Verbose "[$(Get-Date)] Saving document to $out" | ||
| $main | Out-File -FilePath $out -Encoding utf8 | ||
|
|
||
| Write-Progress -Activity $prog.Activity -Completed | ||
|
|
||
| $msg = "Edit and review the adoc files and then run makepdf.ps1." | ||
| Write-Host $msg -ForegroundColor Cyan | ||
|
|
||
| Write-Verbose "[$(Get-Date)] Finished." |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,21 @@ | ||
| { | ||
| "Name" : "ADReportingToolsManual", | ||
| "Title": "ADReportingTools Help Manual", | ||
| "CodeTheme": "github", | ||
| "CodeThemePath": "", | ||
| "Theme": "pdf-theme.yml", | ||
| "Files": [ | ||
| { | ||
| "Name": "Intro.md", | ||
| "Lines": "" | ||
| }, | ||
| { | ||
| "Name": "README.md", | ||
| "Lines": "1;15..-2" | ||
| }, | ||
| { | ||
| "Name": "ModuleCommands.md", | ||
| "Lines": "" | ||
| } | ||
| ] | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.