service-is-documenting | Thomas' Work Space

Bringing method documentation back into synch by using Textpad command line to jump to GrepWin matched line in file

2015/02/14 plagwitz Leave a comment

Objective: is checking, in one simple result window, multi-line matches of method signatures and their Doxygen comments from a multi-module, multi-directory C++ codebase, in order to spot inconsistencies, i.e. where code and documentation are out f synch:
All this short of having to write a Parser or buying a tool like Atomineer Pro Documentation (which does look like it is “right on the money”, but, as it turned out to my surprise, also far short of getting this to work in Eclipse or on a Bash command line with Grep and Perl, ack (doesn’t do multi-line matches!), ag, or what-not. grepWin is free, has an easy-to-use, versatile interface, and proves, once again, to be a powerful little tool.
A a sample (in reality not cut off, of course), 2 methods with their comments showing here:
And I am only a click away from correcting errors I spot in my preferred editor that grepWin can link in “Settings””C:\Program Files (x86)\TextPad 7\TextPad.exe” %path%(%line%,0)
Some grepWin quirk I do not understand:
1. Why does the “Search” button do nothing when I select radio button “Regex” instead of “Text Search”, but does the expected regex match against file and directory name when I select the latter?

Categories: e-infrastructure, service-is-documenting, service-is-programming Tags: ack, bash, doxygen, eclipse, grep, grepwin, Perl, silversearcher, textpad

How to output a list of installed programs on Windows with PowerShell

2015/01/12 plagwitz Leave a comment

A vanilla script, but including all Win32_Product class properties – a quick search found only a very basic version how to do this in PowerShell:

# to write a installed program listing to a CSV file - just adapt the output dir below
Get-WmiObject -Class Win32_Product |`
foreach{
$AssignmentType = $_.AssignmentType
$Caption = $_.Caption
$Description = $_.Description
$IdentifyingNumber = $_.IdentifyingNumber
$InstallDate = $_.InstallDate
$InstallDate2 = $_.InstallDate2
$InstallLocation = $_.InstallLocation
$InstallState = $_.InstallState
$HelpLink = $_.HelpLink
$HelpTelephone = $_.HelpTelephone
$InstallSource = $_.InstallSource
$Language = $_.Language
$LocalPackage = $_.LocalPackage
$Name = $_.Name
$PackageCache = $_.PackageCache
$PackageCode = $_.PackageCode
$PackageName = $_.PackageName
$ProductID = $_.ProductID
$RegOwner = $_.RegOwner
$RegCompany = $_.RegCompany
$SKUNumber = $_.SKUNumber
$Transforms = $_.Transforms
$URLInfoAbout = $_.URLInfoAbout
$URLUpdateInfo = $_.URLUpdateInfo
$Vendor = $_.Vendor
$WordCount = $_.WordCount
$Version = $_.Version

$Name | Select-Object `
@{n="AssignmentType";e={$AssignmentType}},
@{n="Caption";e={$Caption}},
@{n="Description";e={$Description}},
@{n="IdentifyingNumber";e={$IdentifyingNumber}},
@{n="InstallDate";e={$InstallDate}},
@{n="InstallDate2";e={$InstallDate2}},
@{n="InstallLocation";e={$InstallLocation}},
@{n="InstallState";e={$InstallState}},
@{n="HelpLink";e={$HelpLink}},
@{n="HelpTelephone";e={$HelpTelephone}},
@{n="InstallSource";e={$InstallSource}},
@{n="Language";e={$Language}},
@{n="LocalPackage";e={$LocalPackage}},
@{n="Name";e={$Name}},
@{n="PackageCache";e={$PackageCache}},
@{n="PackageCode";e={$PackageCode}},
@{n="PackageName";e={$PackageName}},
@{n="ProductID";e={$ProductID}},
@{n="RegOwner";e={$RegOwner}},
@{n="RegCompany";e={$RegCompany}},
@{n="SKUNumber";e={$SKUNumber}},
@{n="Transforms";e={$Transforms}},
@{n="URLInfoAbout";e={$URLInfoAbout}},
@{n="URLUpdateInfo";e={$URLUpdateInfo}},
@{n="Vendor";e={$Vendor}},
@{n="WordCount";e={$WordCount}},
@{n="Version";e={$Version}}
}| Export-Csv c:\temp\installed-programs.csv -NoTypeInformation

Output:

Categories: e-infrastructure, service-is-documenting, service-is-programming Tags: imaging, powershell, windows, wmi

Fun with .docx to .html transforms by means of HtmlConverter from PowerTools for Open XML

2014/12/15 plagwitz Leave a comment

The transform is FOSS and platform-independent:
1. It neither requires Office nor Windows (The OpenXML SDK runs on Linux via Mono on the server.
2. However, the most recent installment of Powertools for OpenXML, a high-level API to the OpenXML SDK, comes with a PowerShell interface (benefit: no Visual studio requirement).
Valuable features of the transform, among many other things, are:
1. HtmlConverter is able to translate MS-Word styles into CSS (insofar needed – my code style has “No proofing” set, however, this cannot be implemented on the WWW), so the layout is preserved as designed, but w/o need for inline formatting:

        span.pt-StrongEmphasis-000052 {
            font-family: Calibri;
            font-size: 11pt;
            font-style: italic;
            font-weight: bold;
            margin: 0in;
            padding: 0in;
        }

        span.pt-lowCodeConsoleChar0 {
            color: #FFFFFF;
            background: #000000;
            font-family: Consolas;
            font-size: 10pt;
            font-weight: normal;
            margin: 0in;
            padding: 0in;
        }

     &lt;h3 dir=&quot;ltr&quot; class=&quot;pt-000040&quot;&gt;
            &lt;span class=&quot;pt-000041&quot;&gt;2.2.1&lt;/span&gt;&lt;span class=&quot;pt-000042&quot;&gt;&lt;span class=&quot;pt-000043&quot;&gt;&amp;nbsp;&lt;/span&gt;&lt;/span&gt;&lt;span class=&quot;pt-Heading2Char&quot;&gt;&lt;b&gt;References&lt;/b&gt;&lt;/span&gt;
          &lt;/h3&gt;

          &lt;p dir=&quot;ltr&quot; class=&quot;pt-BodyText&quot;&gt;
            &lt;span class=&quot;pt-DefaultParagraphFont-000003&quot;&gt;&lt;br /&gt;
            &amp;lrm;&lt;/span&gt;&lt;span class=&quot;pt-000000&quot;&gt;&amp;nbsp;&lt;/span&gt;
          &lt;/p&gt;

          &lt;h1 dir=&quot;ltr&quot; class=&quot;pt-000006&quot;&gt;
            &lt;span class=&quot;pt-000007&quot;&gt;&lt;b&gt;3&lt;/b&gt;&lt;/span&gt;&lt;span class=&quot;pt-000008&quot;&gt;&lt;b&gt;&lt;span class=&quot;pt-000009&quot;&gt;&amp;nbsp;&lt;/span&gt;&lt;/b&gt;&lt;/span&gt;&lt;span class=&quot;pt-Heading1Char&quot;&gt;&lt;b&gt;Introduction&lt;/b&gt;&lt;/span&gt;
          &lt;/h1&gt;

          &lt;h2 dir=&quot;ltr&quot; class=&quot;pt-000018&quot;&gt;
            &lt;span class=&quot;pt-000019&quot;&gt;3.1&lt;/span&gt;&lt;span class=&quot;pt-000020&quot;&gt;&lt;span class=&quot;pt-000021&quot;&gt;&amp;nbsp;&lt;/span&gt;&lt;/span&gt;&lt;span class=&quot;pt-Heading2Char&quot;&gt;&lt;b&gt;Purpose of Document&lt;/b&gt;&lt;/span&gt;
          &lt;/h2&gt;

There are many more options that I have not yet tried:

            SimplifyMarkupSettings simplifyMarkupSettings = new SimplifyMarkupSettings
            {
                RemoveComments = true,
                RemoveContentControls = true,
                RemoveEndAndFootNotes = true,
                RemoveFieldCodes = false,
                RemoveLastRenderedPageBreak = true,
                RemovePermissions = true,
                RemoveProof = true,
                RemoveRsidInfo = true,
                RemoveSmartTags = true,
                RemoveSoftHyphens = true,
                RemoveGoBackBookmark = true,
                ReplaceTabsWithSpaces = false,
            };
            MarkupSimplifier.SimplifyMarkup(wordDoc, simplifyMarkupSettings);

            FormattingAssemblerSettings formattingAssemblerSettings = new FormattingAssemblerSettings
            {
                RemoveStyleNamesFromParagraphAndRunProperties = false,
                ClearStyles = false,
                RestrictToSupportedLanguages = htmlConverterSettings.RestrictToSupportedLanguages,
                RestrictToSupportedNumberingFormats = htmlConverterSettings.RestrictToSupportedNumberingFormats,
                CreateHtmlConverterAnnotationAttributes = true,
                OrderElementsPerStandard = false,
                ListItemRetrieverSettings = new ListItemRetrieverSettings()
                {
                    ListItemTextImplementations = htmlConverterSettings.ListItemImplementations,
                },
            };

One would really wish there was a way to get such HTML cleaned up automatically (ouch!):

               &lt;span class=&quot;pt-DefaultParagraphFont-000006&quot;&gt;M&lt;/span&gt;
                &lt;span class=&quot;pt-DefaultParagraphFont-000006&quot;&gt;anaged requirements for system integration&amp;nbsp;&lt;/span&gt;
                &lt;span class=&quot;pt-DefaultParagraphFont-000006&quot;&gt;of Center&lt;/span&gt;
                &lt;span class=&quot;pt-DefaultParagraphFont-000006&quot;&gt;&amp;nbsp;&lt;/span&gt;
                &lt;span class=&quot;pt-DefaultParagraphFont-000006&quot;&gt;software&amp;nbsp;&lt;/span&gt;
                &lt;span class=&quot;pt-DefaultParagraphFont-000006&quot;&gt;with&amp;nbsp;&lt;/span&gt;
                &lt;span class=&quot;pt-DefaultParagraphFont-000006&quot;&gt;iLearning&lt;/span&gt;
                &lt;span class=&quot;pt-DefaultParagraphFont-000006&quot;&gt;&amp;nbsp;and with content production and management (BPD). To mitigate lack of integration of $50k LMS software investment into departmental workflow&lt;/span&gt;
                &lt;span class=&quot;pt-DefaultParagraphFont-000006&quot;&gt;,&lt;/span&gt;
                &lt;span class=&quot;pt-DefaultParagraphFont-000006&quot;&gt;&amp;nbsp;&lt;/span&gt;
                &lt;span class=&quot;pt-DefaultParagraphFont-000006&quot;&gt;developed&amp;nbsp;&lt;/span&gt;
                &lt;span class=&quot;pt-DefaultParagraphFont-000006&quot;&gt;and documented&amp;nbsp;&lt;/span&gt;
                &lt;span class=&quot;pt-DefaultParagraphFont-000006&quot;&gt;software to automate&lt;/span&gt;
                &lt;span class=&quot;pt-DefaultParagraphFont-000006&quot;&gt;&amp;nbsp;creation of 4K+ user accounts p.a., 30K+ learning documents and 100K+ interactive content paths in LMS.&lt;/span&gt;

There are also much more serious conversion errors:

MS-Word displays a plain text content control and a repeating section content control within a table, containing one Combobox and one plain text content control per row, perfectly:

Convert-DocxToHtml gobbles the content completely (and so does Google Docs Preview):

The underlying HTML has just a blank table under each heading:

    &lt;div class=&quot;pt-000001&quot;&gt;
        &lt;p dir=&quot;ltr&quot; class=&quot;pt-qiCVHeading1&quot;&gt;
          &lt;span class=&quot;pt-DefaultParagraphFont-000002&quot;&gt;Profile&lt;/span&gt;
        &lt;/p&gt;
      &lt;/div&gt;
      &lt;div align=&quot;left&quot;&gt;
        &lt;table border=&quot;1&quot; cellspacing=&quot;0&quot; cellpadding=&quot;0&quot; dir=&quot;ltr&quot; class=&quot;pt-000003&quot; /&gt;
      &lt;/div&gt;
      &lt;div class=&quot;pt-000001&quot;&gt;
        &lt;p dir=&quot;ltr&quot; class=&quot;pt-qiCVHeading1&quot;&gt;
          &lt;span class=&quot;pt-DefaultParagraphFont-000002&quot;&gt;Technologies&lt;/span&gt;
        &lt;/p&gt;
      &lt;/div&gt;
      &lt;div align=&quot;left&quot;&gt;
        &lt;table border=&quot;1&quot; cellspacing=&quot;0&quot; cellpadding=&quot;0&quot; dir=&quot;ltr&quot; class=&quot;pt-000003&quot; /&gt;
      &lt;/div&gt;

MS-Word shows:Yet need to look in to the underlying XML to see whether the .docx is to blame for that…
But HtmlConverter output in IE or Firefox: The underlying HTML reveals that the css does not get applied in the right place:

 	&lt;tr&gt;
                &lt;td class=&quot;pt-000079&quot;&gt;
                  &lt;p dir=&quot;ltr&quot; class=&quot;pt-BodyTextSmall&quot;&gt;
                    &lt;span class=&quot;pt-BodyTextSmallChar-000081&quot;&gt;AD&lt;/span&gt;
                  &lt;/p&gt;
                &lt;/td&gt;
                &lt;td colspan=&quot;2&quot; class=&quot;pt-000079&quot;&gt;
                  &lt;p dir=&quot;ltr&quot; class=&quot;pt-BodyTextSmall&quot;&gt;
                    &lt;span class=&quot;pt-BodyTextSmallChar-000081&quot;&gt;Active Driector, Microsfot&amp;rsquo;s directory implementation.&lt;/span&gt;
                  &lt;/p&gt;
                &lt;/td&gt;
              &lt;/tr&gt;

              &lt;tr&gt;
                &lt;td class=&quot;pt-000086&quot;&gt;
                  &lt;p dir=&quot;ltr&quot; class=&quot;pt-BodyTextSmall&quot;&gt;
                    &lt;span class=&quot;pt-000085&quot;&gt;&amp;nbsp;&lt;/span&gt;
                  &lt;/p&gt;
                &lt;/td&gt;
                &lt;td colspan=&quot;2&quot; class=&quot;pt-000086&quot;&gt;
                  &lt;p dir=&quot;ltr&quot; class=&quot;pt-BodyTextSmall&quot;&gt;
                    &lt;span class=&quot;pt-000085&quot;&gt;&amp;nbsp;&lt;/span&gt;
                  &lt;/p&gt;
                &lt;/td&gt;
              &lt;/tr&gt;

One could imagine MS-Word acting less strictly than OpenXML PowerTools:Convert-DocxToHtml, like a web-browser’s parser tolerates and displays bad HTML. However, not only would need to be justified how MS-Word can also serve as the originating HTML WYSIWYG editor. The OpenXML PowerTools:Get-OpenXmlValidationErrors for both of the above documents does not seem to find any OpenXML errors that could explain the bad conversion (other than dozens of Sch_UndeclaredAttribute errors (Version-related? Not sure how this could be) , there is only a Pkg_PartIsNotAllowed relating to a glossary).

Also yet to do:
1. When (not always!) does my page title end up as empty?
```
&lt;title&gt;&lt;/title&gt;
```
2. Defaults to doctype xhtml, not html(5).
Done:
```
openXml\OxPt\OxPtCmdlets\OxPtHelper.cs:var htmlString = html.ToString(SaveOptions.None); // trp: requesting pretty-printing, was:html.ToString(SaveOptions.DisableFormatting);
```

Categories: e-infrastructure, service-is-documenting Tags: Convert-DocxToHtml, Get-OpenXmlValidationErrors, MS-Word, openxml, powertools-for-openxml, single-sourcing, XML

How to fix MS-Word not creating PDF Bookmarks for your Headings

2014/10/29 plagwitz Leave a comment

Problem: No navigation bar in Acrobat Reader when viewing your PDF created from MS-Word.
Solution: Check this setting first in the Save as PDF Options:
But: Word 2013’s “Save as PDF” with “Create Bookmarks” may remains greyed out since it won’t even see your own heading styles, even if you based these styles on the built-in heading styles (which are known to contain “hidden magic” not easily replicated) , including their outline level, if
1. Heading appears in Content control.
2. Heading appears in Table.
Workaround:
1. Move headings out of Content Controls (you can still “lock”the text with Grouping, which will be enabled on the Developer Tab once you select at least a conten control and text (meant for form field labels).
2. Move headings outside of tables.

Categories: Glitches&Errors, office-software, service-is-documenting Tags: 2013, adobe-acrobat, bookmarks, content-controls, headings, MS-Word, outlining, pdf, tables

We can nest controls in repeating content controls, including repeating content controls

2014/10/06 plagwitz Leave a comment

Just saying, since it seems not easy to find within web search results the ones that nest nesting….
Have not tried accessing the results in OpenXML yet which will have to be done via the control ID
1. since repeating:
2. does not autoincrement the titles and tags.

Categories: animated-GIFs, e-infrastructure, service-is-documenting Tags: 2013, content-controls, MS-Word

How to get Square brackets (and hide comments) with ISO690 in Word 2013 bibliography styles

2014/09/14 plagwitz 2 comments

Lots of people online seem to be looking for square brackets with citations in ISO690 style in Word 2013, but having no luck with getting the Bibliography XSL for older Word versions to work. Trying to edit the old XSL still results in it not loading into the MS-Word Citation Style dropdown.
What is needed is a way to parse the XSL and debug load errors. In the meantime…
I had better luck with starting from the current Word2013 ISO style. If you stream Office365, this is now in %appdata%\Microsoft\Templates\LiveContent\15\Managed\Word Document Bibliography Styles
1. Puzzlingly, there is also a %appdata%\Microsoft\Bibliography\Style which some of your edited files get copied to – go figure….
2. The ISO690 file I based my variation on is called : TC102851224[[fn=iso690nmerical]].xsl
3. Copy this file to %appdata%\Microsoft\Templates\LiveContent\15\User\Word Document Bibliography Styles\
4. Open it with a text editor (I use NotePad++).
5. Change “Openbracket” section like so: And the corresponding for closebracket
  <!– trp: –>
  [
6. Same principle change for the corresponding for “Closebracket“
  1. Lst time I carelessly introduced printing space characters before my closing brackets – just copy the leading chars from a working XML line if you run into this problem.
I also needed to not print “Comment”-field of the source in my bibliography”
1. Search for:
2. Comment out the “print”-action inside (easier than changing each bibliographgy type):<!– trp:
  –>
Change the style name. MS-Word 2013 uses “StyleNameLocalized” instead of “StyleName”, so I added a qualifier to each localized name within the test:
ISO 690YOURNAMEHERE
Restart MS-Word, and with luck, your styles will show in the ribbon References section style dropdown: . Apply them (using F9):
Download: TC102851224[[fn=iso690nmericalsquare0comments]]

Categories: e-infrastructure, e-research, office-software, service-is-documenting Tags: 2013, bibliographies, comments, iso690, MS-Word, square-brackets, styles, XML, xsl

Protected: LRC calendars requirements and configuration management

2014/07/15 plagwitz Enter your password to view comments.

Categories: e-infrastructure, service-is-documenting, service-is-project-managing, Spreadsheets Tags: calendaring, configuration-management, live@edu, ms-exchange, office365, outlook, outlook-live, renaming, requirements-management, resources, scheduling

UNC-Charlotte Shortcuts

2014/07/15 plagwitz Leave a comment

Archived Links: Need Help?For general computer problems call central Helpdesk: x75500 to get remote assistance on your computer. Or post to online or email help at uncc.edu. Also check for campus-wide known issues on the ITS Alerts page. LRC-specific problems? 1st ask LRC help desk. Then email a photo of problem/screen from your phone to lrchelp at uncc.edu.

Categories: Institution-is-University-of-North-Carolina-Charlotte, service-is-documenting

Newer Entries Older Entries

Thomas' Work Space

Archive

Bringing method documentation back into synch by using Textpad command line to jump to GrepWin matched line in file

How to output a list of installed programs on Windows with PowerShell

Fun with .docx to .html transforms by means of HtmlConverter from PowerTools for Open XML

How to fix MS-Word not creating PDF Bookmarks for your Headings

We can nest controls in repeating content controls, including repeating content controls

How to get Square brackets (and hide comments) with ISO690 in Word 2013 bibliography styles

Protected: LRC calendars requirements and configuration management

UNC-Charlotte Shortcuts

Blog Stats

Your message has been sent

Top Posts & Pages

Top Clicks

Categories

Email Subscription

Archives

Top