[prev in list] [next in list] [prev in thread] [next in thread] 

List:       kde-frameworks-devel
Subject:    Review Request 129661: optional CHM generation
From:       René J.V. Bertin <rjvbertin () gmail ! com>
Date:       2016-12-16 21:55:41
Message-ID: 20161216215541.4515.87247 () mimi ! kde ! org
[Download RAW message or body]

--===============3325998953352974812==
MIME-Version: 1.0
Content-Type: text/plain; charset="utf-8"
Content-Transfer-Encoding: 8bit


-----------------------------------------------------------
This is an automatically generated e-mail. To reply, visit:
https://git.reviewboard.kde.org/r/129661/
-----------------------------------------------------------

Review request for KDE Frameworks and Olivier Churlaud.


Bugs: 373723
    https://bugs.kde.org/show_bug.cgi?id=373723


Repository: kapidox


Description
-------

This implements the suggestion detailed in the linked wishlist bug report: optional \
generation of a compressed help (.chm) file.

The patch introduces 2 new kapidox_generate options:
--chm : generate a chm file
--chmcompiler : path to the chm compiler; `hhc.exec` on MS Windows, or `chmcmd` (from \
the `Free Pascal` utilities) on *n*x.

Currently both options have to be used, there may be an elegant way to combine them.


Diffs
-----

  src/kapidox/argparserutils.py 7d29c57 
  src/kapidox/generator.py ff8fcac 

Diff: https://git.reviewboard.kde.org/r/129661/diff/


Testing
-------

Works as expected on Mac and Linux


File Attachments
----------------

example chm file; KSyntaxHighlighting 5.28.0
  https://git.reviewboard.kde.org/media/uploaded/files/2016/12/16/591489b6-9b71-4076-be1a-64258d80c8c3__SyntaxHighlighting.chm



Thanks,

René J.V. Bertin


--===============3325998953352974812==
MIME-Version: 1.0
Content-Type: text/html; charset="utf-8"
Content-Transfer-Encoding: 8bit




<html>
 <body>
  <div style="font-family: Verdana, Arial, Helvetica, Sans-Serif;">
   <table bgcolor="#f9f3c9" width="100%" cellpadding="12" style="border: 1px #c9c399 \
solid; border-radius: 6px; -moz-border-radius: 6px; -webkit-border-radius: 6px;">  \
<tr>  <td>
      This is an automatically generated e-mail. To reply, visit:
      <a href="https://git.reviewboard.kde.org/r/129661/">https://git.reviewboard.kde.org/r/129661/</a>
  </td>
    </tr>
   </table>
   <br />




<table bgcolor="#fefadf" width="100%" cellspacing="0" cellpadding="12" style="border: \
1px #888a85 solid; border-radius: 6px; -moz-border-radius: 6px; \
-webkit-border-radius: 6px;">  <tr>
  <td>

<div>Review request for KDE Frameworks and Olivier Churlaud.</div>
<div>By René J.V. Bertin.</div>








<div style="margin-top: 1.5em;">
 <b style="color: #575012; font-size: 10pt; margin-top: 1.5em;">Bugs: </b>


 <a href="https://bugs.kde.org/show_bug.cgi?id=373723">373723</a>


</div>



<div style="margin-top: 1.5em;">
 <b style="color: #575012; font-size: 10pt;">Repository: </b>
kapidox
</div>


<h1 style="color: #575012; font-size: 10pt; margin-top: 1.5em;">Description </h1>
 <table width="100%" bgcolor="#ffffff" cellspacing="0" cellpadding="10" \
style="border: 1px solid #b8b5a0">  <tr>
  <td>
   <pre style="margin: 0; padding: 0; white-space: pre-wrap; white-space: \
-moz-pre-wrap; white-space: -pre-wrap; white-space: -o-pre-wrap; word-wrap: \
break-word;"><p style="padding: 0;text-rendering: inherit;margin: 0;line-height: \
inherit;white-space: inherit;">This implements the suggestion detailed in the linked \
wishlist bug report: optional generation of a compressed help (.chm) file.</p> <p \
style="padding: 0;text-rendering: inherit;margin: 0;line-height: inherit;white-space: \
                inherit;">The patch introduces 2 new kapidox_generate options:
--chm : generate a chm file
--chmcompiler : path to the chm compiler; <code style="text-rendering: inherit;color: \
#4444cc;padding: 0;white-space: normal;margin: 0;line-height: \
inherit;">hhc.exec</code> on MS Windows, or <code style="text-rendering: \
inherit;color: #4444cc;padding: 0;white-space: normal;margin: 0;line-height: \
inherit;">chmcmd</code> (from the <code style="text-rendering: inherit;color: \
#4444cc;padding: 0;white-space: normal;margin: 0;line-height: inherit;">Free \
Pascal</code> utilities) on *n*x.</p> <p style="padding: 0;text-rendering: \
inherit;margin: 0;line-height: inherit;white-space: inherit;">Currently both options \
have to be used, there may be an elegant way to combine them.</p></pre>  </td>
 </tr>
</table>


<h1 style="color: #575012; font-size: 10pt; margin-top: 1.5em;">Testing </h1>
<table width="100%" bgcolor="#ffffff" cellspacing="0" cellpadding="10" style="border: \
1px solid #b8b5a0">  <tr>
  <td>
   <pre style="margin: 0; padding: 0; white-space: pre-wrap; white-space: \
-moz-pre-wrap; white-space: -pre-wrap; white-space: -o-pre-wrap; word-wrap: \
break-word;"><p style="padding: 0;text-rendering: inherit;margin: 0;line-height: \
inherit;white-space: inherit;">Works as expected on Mac and Linux</p></pre>  </td>
 </tr>
</table>


<h1 style="color: #575012; font-size: 10pt; margin-top: 1.5em;">Diffs</b> </h1>
<ul style="margin-left: 3em; padding-left: 0;">

 <li>src/kapidox/argparserutils.py <span style="color: grey">(7d29c57)</span></li>

 <li>src/kapidox/generator.py <span style="color: grey">(ff8fcac)</span></li>

</ul>

<p><a href="https://git.reviewboard.kde.org/r/129661/diff/" style="margin-left: \
3em;">View Diff</a></p>



<h1 style="color: #575012; font-size: 10pt; margin-top: 1.5em;">File Attachments \
</h1>


 <li><a href="https://git.reviewboard.kde.org/media/uploaded/files/2016/12/16/591489b6-9b71-4076-be1a-64258d80c8c3__SyntaxHighlighting.chm">example \
chm file; KSyntaxHighlighting 5.28.0</a></li>

</ul>




  </td>
 </tr>
</table>



  </div>
 </body>
</html>


--===============3325998953352974812==--


[prev in list] [next in list] [prev in thread] [next in thread]

Configure | About | News | Add a list | Sponsored by KoreLogic