Consider providing CHM documentation officially

[yii-bot]

This issue has originally been reported by @cebe at yiisoft/yii2#4279.
Moved here by @cebe.

---

No priority for now but here are some references:

• https://github.com/bisubus/yii2-apidocchm
• #1797

[lourdas]

What about the status of this issue? Will there be an official release of the documentation in chm format, which is much more usable than the HTML or pdf format?

The bisubus repository provided a chm file, which was missing many parts from the official apidoc.

[samdark]

Maybe one day but that is not a priority. We'll likely use @bisubus solution so it makes sense to fix issues in it.

[lourdas]

In bisubus#3 (comment) bisubus states that he doesn't have enough time to work on it, so it will probably not get updated, unless someone takes over.

[samdark]

Well, that's better than starting from scratch.

[blacksmoke26]

Well I have started to provide CHM files along with the WebHelp and HHP Source project;
Check here: https://github.com/blacksmoke26/Yii2-Manual-CHM/releases

[bisubus]

@blacksmoke26 Is building process too complex to be contributed to this repo?

[blacksmoke26]

Nope, I can easily manage things!

[blacksmoke26]

@cebe @samdark Has someone updated the cookbook?
https://yii2-cookbook.readthedocs.io/

I have combined all the related docs in one place:
Guide, Manual, API, Extensions Docs, Cookbook, Internal Docs, Wiki

@samdark @bisubus @lourdas Need suggestions about that, better to keep that format?

Better checking attached chm file:
yii2-2.0.13-dev-manual-2017-07-09.chm.zip

[lourdas]

@blacksmoke26 The attached chm looks just fine to me.

[blacksmoke26]

@lourdas Still incomplete! Will see if the new format will be approved by core team.

[samdark]

Cookbook isn't part of the official guide so it's a bit confusing to have all that in a single file.

[blacksmoke26]

@samdark any suggestion about that? Only Guide/API/Docs are the parts of Manual?

[samdark]

Yes. I'd suggest cookbook being distributed separately.

[blacksmoke26]

Done. Thanks!

[blacksmoke26]

Updates:

Extensions guide added now, Please check the following image:

Zipped CHM file here:
yii2-2.0.12-manual-2017-07-17.chm.zip

[roslov]

Screenshots and images are not shown in this CHM file.

[blacksmoke26]

@roslov If you are using Windows XP SP2 or later and you are going to download the documentation in CHM format, you need to "unblock" the file after downloading it by right-clicking on it in Windows Explorer and selecting the "Properties" menu item, then clicking on the "Unblock" button (on Windows Vista this is within the "Security" options). Failure to unblock the documentation file may result in error messages including "Navigation to the webpage was canceled" due to Windows security restrictions.

CHM file is working fine here

[roslov]

@blacksmoke26 I’m using Windows 10.
I tried something like Unblock-File -Path yii2-2.0.12-manual-2017-07-17.chm from PowerShell, but it did not work for me.

[blacksmoke26]

Please better create an issue on:
https://github.com/blacksmoke26/Yii2-Manual-CHM/issues

I will take care of that!

[roslov]

@blacksmoke26, done.
blacksmoke26/yii2-manual-chm#3

[samdark]

Closing as won't implement since CHM format, while very convenient is quite dated and can't be efficiently viewed on newer systems.