Making CHM version of the User Guide and Reference...

Blender documentation projects, tutorials, translation, learning & teaching Blender

Moderators: jesterKing, stiv

Post Reply
xeetstreet
Posts: 0
Joined: Sun Nov 21, 2004 7:52 am

Making CHM version of the User Guide and Reference...

Post by xeetstreet »

Has anyone attempted making a CHM version of the User Guide and Reference. I am pretty sure that CHM's are compiled using HTML files.

This way, the help is quickly searchable and easily browsable. Just curious...

halibut
Posts: 0
Joined: Fri Apr 25, 2003 2:02 pm
Contact:

Re: Making CHM version of the User Guide and Reference...

Post by halibut »

xeetstreet wrote:Has anyone attempted making a CHM version of the User Guide and Reference. I am pretty sure that CHM's are compiled using HTML files.

This way, the help is quickly searchable and easily browsable. Just curious...
This is windows only (I think?) and requires the whole documentation to be downloaded, rather than the small part one may be searching for, so I doubt this will happen.

It also means peoples documentation will go out of date, the most up to date version is online :)

ben_o
Posts: 0
Joined: Tue Sep 14, 2004 3:54 pm

Post by ben_o »

There is a linux viewer for chm files and its called 'xchm' (everything in linux has awe-inspiring names, don't it ;) ) I have used it before, and it does what it says it should do, and quite nicely as well.

I feel that .chm files are still devil spawn, but at least this would be a step up from a newbie point of view, for those trying to get to grips with blender.

Ben

Bellorum
Posts: 0
Joined: Wed Jan 21, 2004 3:27 pm

Post by Bellorum »

.chm-files are da bomb! Alot easier to overview than a web of HTML-pages. I was actually considering converting everything myself, but it proved too much of a hassle :? I simply don't have the time:p
There's no such thing as democracy. There's only the tyranny of one, and the tyranny of many.

xeetstreet
Posts: 0
Joined: Sun Nov 21, 2004 7:52 am

Post by xeetstreet »

Bellorum wrote:.chm-files are da bomb! Alot easier to overview than a web of HTML-pages. I was actually considering converting everything myself, but it proved too much of a hassle :? I simply don't have the time:p
Yes! You've seen the light. There was a point in time when I attempted to make a .chm for something else, but it too was a fairly taxing task. I'll try again... ;)

kisolre
Posts: 0
Joined: Sat Jul 17, 2004 7:48 pm

Post by kisolre »

Just tried User guide and it compiled ok. 44 915 235 bytes .chm :)

I use eDE from http://docbook.e-novative.de/
http://www.e-novative-download.de/setup_eDE_1.3.0.exe

with little modifications so it can work in every folder.

indigomonkey
Posts: 0
Joined: Fri Oct 08, 2004 12:48 pm

Post by indigomonkey »

I'm not aquainted with .chm - what are they?

infinder
Posts: 2
Joined: Thu Feb 13, 2003 8:58 am
Contact:

Post by infinder »

This is great!
Any chance to download it from somewere?

Stamatis

kisolre
Posts: 0
Joined: Sat Jul 17, 2004 7:48 pm

Post by kisolre »

my internet is trafic limited and I almost reached my montlhy trafic :( No way and also no place where to upload it. Maybe if someone else can do it and upload it to the documentation page...

Or you can see http://www.blender3d.org/cms/Documentat ... 264.0.html for how to download the current CVS (~51 MB) and follow this to compile it locally:

To edit .XML files you can use Scite from http://www.scintilla.org It supports syntactic highlighting and tag folding. also you can automatically open files which names are under cursor. See "File\Open selected file". Very useful I think.

To validate your edits and to convert .XML to more readable format you can use eDE as follows:

Download eDE from http://www.e-novative-download.de/setup_eDE_1.3.0.exe. (~27 MB)
Main page is http://docbook.e-novative.de/ but it may not work now.

Install it.

Create file C:\docbook\stylesheet\custom_configuration.bat as follows

------custom_configuration.bat---------
@echo off
echo\

set docbook_document_repository=.
set docbook_document_output=.
set docbook_document_deploy=.
set document_repository=.
---------------------------------------

This allows to work with documents outside eDE's repository

change line 41 of C:\docbook\bat\docbook_validate.bat
from
%docbook_path%\bin\xmllint.exe -noout -valid -postvalid %1.xml
to
%docbook_path%\bin\xmllint.exe -noout -noent -postvalid %1.xml

This unfolds all entities before XML validation so external (for validated file) xref's could be checked.

By default procesing adds "This document was created using the >e-novative> DocBook Environment (eDE)"
as header and footer to every chapter. If you want to remove it or change it with your own see comments in C:\docbook\stylesheet\e-novative.xsl lines 387-416.

cd to your BlenderManual CVS directory.

To convert .XML file to one .HTML file type
docbook_html BlenderManualIen .\

This will create one file for the supplied .XML (BlenderManualIen) in current folder.

To convert .XML file to multiple .HTML files type
docbook_html BlenderManualIen .\

This will create multiple files (for each chapter, ...) for the supplied .XML (BlenderManualIen) in current folder.

To convert .XML file to .CHM files type
docbook_htmlhelp BlenderManualIen .\

This will create multiple files (for each chapter, ...) for the supplied .XML (BlenderManualIen) in current folder and after that compile them to produce single .CHM file.

note: .XML file name must be written without extension eg. BlenderBanualIen instead of BlenderBanualIen.xml

Hope this helps :)

infinder
Posts: 2
Joined: Thu Feb 13, 2003 8:58 am
Contact:

Post by infinder »

Thank you very much..!

Stamatis

Post Reply