NO

Author Topic: TOC.YML to HHC and HHK  (Read 545 times)

Offline John Z

  • Member
  • *
  • Posts: 509
TOC.YML to HHC and HHK
« on: August 25, 2022, 06:04:56 pm »
This is an updated version of a small 'DOS' command line program to convert toc.yml file from
https://github.com/MicrosoftDocs/win32 into suitable Content (hhc) and
Index (hhk) files needed for creating a .chm help file.

syntax, which will also show by C:>ymltoc (enter)

Syntax: C:>ymltoc yml_input_filename [output filename] [switches] <ENTER>
[ ] = optional,  switches shown below do not include the [ ]
  /E Echo to screen
  /noheader Suppress header output
  /nofooter Suppress footer output
  Separate switches with a space.
 
[output filename]  optional input to change the output base name this
option, if used must be in position 2  if not entered the output
uses the base name of the input file and an extension of .hhc and .hhk

[switches] optional output options in any order, case insensitive
/E - echo's lines to the screen
/noheader optional suppression of the .chm format header
/nofooter optional suppression of the .chm format footer

Example
C:> ymltoc toc.yml abc /e (enter) creates abc.hhc and abc.hhk echo to screen too
or
C:> ymltoc toc.yml (enter) creates toc.hhc and toc.hhk no echo

Hope useful,
John Z

Updated to version 1.1
« Last Edit: August 30, 2022, 01:17:32 pm by John Z »

Offline TimoVJL

  • Global Moderator
  • Member
  • *****
  • Posts: 2006
Re: TOC.YML to HHC and HHK
« Reply #1 on: August 26, 2022, 01:49:54 pm »
Now we can start thinking a common index system for that MS doc site.
We can think it as folder tree, that we pack to zip by folders, similar like MS system, to avoid big files.
A MS Help 3 msh* system is private, but it works, so now is opportinity make similar, that is open and public.


May the source be with you

Offline John Z

  • Member
  • *
  • Posts: 509
Re: TOC.YML to HHC and HHK
« Reply #2 on: August 26, 2022, 02:35:39 pm »
Hmmm...

The toc.yml is an easy format and already completed for each folder.  Here is the one for the Controls folder.
Benefit is if the Github updates it, it is easy to replace.  Might be worth renaming to match folder name though.


John Z

Offline CandCPlusPlus

  • Member
  • *
  • Posts: 51
Re: TOC.YML to HHC and HHK
« Reply #3 on: August 27, 2022, 07:20:55 pm »
This is an interesting tool. A tool for converting the Microsoft docs on github to .chm format "on the fly" would be quite useful.

Offline John Z

  • Member
  • *
  • Posts: 509
Re: TOC.YML to HHC and HHK
« Reply #4 on: August 28, 2022, 11:30:51 am »
CandCPlusPlus,

You might be interested in this toolset - it is still available and free.  Not sure how much longer the
web site will be up.  Handles multiple help formats too.

https://forum.pellesc.de/index.php?topic=9724.msg32568#msg32568


John Z

Offline CandCPlusPlus

  • Member
  • *
  • Posts: 51
Re: TOC.YML to HHC and HHK
« Reply #5 on: August 28, 2022, 08:18:52 pm »
CandCPlusPlus,

You might be interested in this toolset - it is still available and free.  Not sure how much longer the
web site will be up.  Handles multiple help formats too.

https://forum.pellesc.de/index.php?topic=9724.msg32568#msg32568


John Z

I saw that post before and I downloaded FAR HTML.