Skip to content

Commit

Permalink
Updated the Documentation Introduction Chapter
Browse files Browse the repository at this point in the history
  • Loading branch information
JorjMcKie committed Aug 1, 2015
1 parent 92faf7d commit 73dae28
Show file tree
Hide file tree
Showing 8 changed files with 42 additions and 18 deletions.
Binary file modified doc/PyMuPDF.chm.zip
Binary file not shown.
Binary file modified doc/PyMuPDF.pdf.zip
Binary file not shown.
19 changes: 13 additions & 6 deletions doc/html/_sources/intro.txt
Expand Up @@ -7,7 +7,7 @@ MuPDF can access files in PDF, XPS, OpenXPS, CBZ (comic book) and EPUB (e-book)

These are files with extensions ``*.pdf``, ``*.xps``, ``*.oxps``, ``*.cbz`` or ``*.epub`` (so in essence, with this binding you can develop **e-book viewers in Python** ...)

PyMuPDF provides access to all important functions of MuPDF from within a Python environment. Nevertheless, we will always consider expanding this function set.
PyMuPDF provides access to all important functions of MuPDF from within a Python environment. Nevertheless, we are continuously expanding this function set.

MuPDF stands out among all similar products for its top rendering capability and unsurpassed processing speed.

Expand All @@ -20,15 +20,22 @@ And we are determined to keep PyMuPDF current with future MuPDF changes!

This work is now completed.

PyMuPDF has been tested on Linux, Windows 7 and up, Python 2 and Python 3 (x86 versions). Other OS platforms should work too as long as MuPDF supports them.
PyMuPDF has been tested on Linux, Windows 7 and up, Python 2 and Python 3 (x86 versions). Other platforms should work too as long as MuPDF supports them.

**So, what do we have?**
The main differences compared to version 1.2 are

* We have ready and working installation procedures for Linux and Windows.
* A greatly simplified installation procedure: For Windows and Linux platforms it should come down to running the ``python setup.py install`` command.

* We have example and demo scripts for typical use cases that you can take as templates for your development.
* The API has changed: it is now simpler and a lot less cryptic.

* Compared to version 1.2, we have greatly simplified the installation procedure for Windows and Linux platforms.
* The supported function set has been significantly increased: apart from rendering, MuPDF's traditional strength, we now also offer a wide range of text extraction options.

* Demo code has been extended, and an additional ``examples`` directory is there to contain working programs. Among them are an editor for a document's table of contents, a full featured document joiner and a document-to-text conversion utility.

We invite you to join our efforts by contributing to the the wiki pages, by using what is there - and, of course, by submitting issues and bugs to the site!

Note on the Name ``fitz``
--------------------------
The Python import statement for this library is ``import fitz``. Here is the reason why:

The original rendering library for MuPDF was called ``Libart``. "After Artifex Software acquired the MuPDF project, the development focus shifted on writing a new modern graphics library called ``Fitz``. Fitz was originally intended as an R&D project to replace the aging Ghostscript graphics library, but has instead become the rendering engine powering MuPDF." (Quoted from `Wikipedia <https://en.wikipedia.org/wiki/MuPDF>`_).
2 changes: 1 addition & 1 deletion doc/html/genindex.html
Expand Up @@ -852,7 +852,7 @@ <h3>Navigation</h3>
</div>
<div class="footer" role="contentinfo">
&copy; Copyright 2015, Ruikai Liu, Jorj McKie.
Last updated on 30. Jul 2015.
Last updated on 01. Aug 2015.
Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.3.1.
</div>
</body>
Expand Down
7 changes: 5 additions & 2 deletions doc/html/index.html
Expand Up @@ -77,7 +77,10 @@ <h3>Quick search</h3>
<h1><strong>The PyMuPDF Documentation</strong><a class="headerlink" href="#the-pymupdf-documentation" title="Permalink to this headline"></a></h1>
<div class="toctree-wrapper compound">
<ul>
<li class="toctree-l1"><a class="reference internal" href="intro.html">Introduction</a></li>
<li class="toctree-l1"><a class="reference internal" href="intro.html">Introduction</a><ul>
<li class="toctree-l2"><a class="reference internal" href="intro.html#note-on-the-name-fitz">Note on the Name <code class="docutils literal"><span class="pre">fitz</span></code></a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="installation.html">Installation</a><ul>
<li class="toctree-l2"><a class="reference internal" href="installation.html#step-1-download-pymupdf">Step 1: Download PyMuPDF</a></li>
<li class="toctree-l2"><a class="reference internal" href="installation.html#step-2-download-mupdf-1-7a">Step 2: Download MuPDF 1.7a</a></li>
Expand Down Expand Up @@ -134,7 +137,7 @@ <h3>Navigation</h3>
</div>
<div class="footer" role="contentinfo">
&copy; Copyright 2015, Ruikai Liu, Jorj McKie.
Last updated on 30. Jul 2015.
Last updated on 01. Aug 2015.
Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.3.1.
</div>
</body>
Expand Down
28 changes: 21 additions & 7 deletions doc/html/intro.html
Expand Up @@ -46,6 +46,14 @@ <h3>Navigation</h3>
</div>
<div class="sphinxsidebar" role="navigation" aria-label="main navigation">
<div class="sphinxsidebarwrapper">
<h3><a href="index.html">Table Of Contents</a></h3>
<ul>
<li><a class="reference internal" href="#">Introduction</a><ul>
<li><a class="reference internal" href="#note-on-the-name-fitz">Note on the Name <code class="docutils literal"><span class="pre">fitz</span></code></a></li>
</ul>
</li>
</ul>

<h4>Previous topic</h4>
<p class="topless"><a href="index.html"
title="previous chapter"><strong>The PyMuPDF Documentation</strong></a></p>
Expand Down Expand Up @@ -85,21 +93,27 @@ <h1>Introduction<a class="headerlink" href="#introduction" title="Permalink to t
<p><strong>PyMuPDF</strong> (formerly known as python-fitz) is a Python binding for <a class="reference external" href="http://www.mupdf.com/">MuPDF</a> - &#8220;a lightweight PDF and XPS viewer&#8221;.</p>
<p>MuPDF can access files in PDF, XPS, OpenXPS, CBZ (comic book) and EPUB (e-book) formats.</p>
<p>These are files with extensions <code class="docutils literal"><span class="pre">*.pdf</span></code>, <code class="docutils literal"><span class="pre">*.xps</span></code>, <code class="docutils literal"><span class="pre">*.oxps</span></code>, <code class="docutils literal"><span class="pre">*.cbz</span></code> or <code class="docutils literal"><span class="pre">*.epub</span></code> (so in essence, with this binding you can develop <strong>e-book viewers in Python</strong> ...)</p>
<p>PyMuPDF provides access to all important functions of MuPDF from within a Python environment. Nevertheless, we will always consider expanding this function set.</p>
<p>PyMuPDF provides access to all important functions of MuPDF from within a Python environment. Nevertheless, we are continuously expanding this function set.</p>
<p>MuPDF stands out among all similar products for its top rendering capability and unsurpassed processing speed.</p>
<p>You can check this out yourself:
Compare the various free PDF-viewers. In terms of speed and rendering quality <a class="reference external" href="http://www.sumatrapdfreader.org/">SumatraPDF</a> ranges at the top (apart from MuPDF&#8217;s own standalone viewer) - and it is based on MuPDF!</p>
<p>While PyMuPDF has been available since several years for an earlier version of MuPDF (1.2), it was until only mid May 2015, that its creator and a few co-workers decided to elevate it to support the current release of MuPDF (1.7a).</p>
<p>And we are determined to keep PyMuPDF current with future MuPDF changes!</p>
<p>This work is now completed.</p>
<p>PyMuPDF has been tested on Linux, Windows 7 and up, Python 2 and Python 3 (x86 versions). Other OS platforms should work too as long as MuPDF supports them.</p>
<p><strong>So, what do we have?</strong></p>
<p>PyMuPDF has been tested on Linux, Windows 7 and up, Python 2 and Python 3 (x86 versions). Other platforms should work too as long as MuPDF supports them.</p>
<p>The main differences compared to version 1.2 are</p>
<ul class="simple">
<li>We have ready and working installation procedures for Linux and Windows.</li>
<li>We have example and demo scripts for typical use cases that you can take as templates for your development.</li>
<li>Compared to version 1.2, we have greatly simplified the installation procedure for Windows and Linux platforms.</li>
<li>A greatly simplified installation procedure: For Windows and Linux platforms it should come down to running the <code class="docutils literal"><span class="pre">python</span> <span class="pre">setup.py</span> <span class="pre">install</span></code> command.</li>
<li>The API has changed: it is now simpler and a lot less cryptic.</li>
<li>The supported function set has been significantly increased: apart from rendering, MuPDF&#8217;s traditional strength, we now also offer a wide range of text extraction options.</li>
<li>Demo code has been extended, and an additional <code class="docutils literal"><span class="pre">examples</span></code> directory is there to contain working programs. Among them are an editor for a document&#8217;s table of contents, a full featured document joiner and a document-to-text conversion utility.</li>
</ul>
<p>We invite you to join our efforts by contributing to the the wiki pages, by using what is there - and, of course, by submitting issues and bugs to the site!</p>
<div class="section" id="note-on-the-name-fitz">
<h2>Note on the Name <code class="docutils literal"><span class="pre">fitz</span></code><a class="headerlink" href="#note-on-the-name-fitz" title="Permalink to this headline"></a></h2>
<p>The Python import statement for this library is <code class="docutils literal"><span class="pre">import</span> <span class="pre">fitz</span></code>. Here is the reason why:</p>
<p>The original rendering library for MuPDF was called <code class="docutils literal"><span class="pre">Libart</span></code>. &#8220;After Artifex Software acquired the MuPDF project, the development focus shifted on writing a new modern graphics library called <code class="docutils literal"><span class="pre">Fitz</span></code>. Fitz was originally intended as an R&amp;D project to replace the aging Ghostscript graphics library, but has instead become the rendering engine powering MuPDF.&#8221; (Quoted from <a class="reference external" href="https://en.wikipedia.org/wiki/MuPDF">Wikipedia</a>).</p>
</div>
</div>


Expand All @@ -125,7 +139,7 @@ <h3>Navigation</h3>
</div>
<div class="footer" role="contentinfo">
&copy; Copyright 2015, Ruikai Liu, Jorj McKie.
Last updated on 30. Jul 2015.
Last updated on 01. Aug 2015.
Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.3.1.
</div>
</body>
Expand Down
2 changes: 1 addition & 1 deletion doc/html/search.html
Expand Up @@ -94,7 +94,7 @@ <h3>Navigation</h3>
</div>
<div class="footer" role="contentinfo">
&copy; Copyright 2015, Ruikai Liu, Jorj McKie.
Last updated on 30. Jul 2015.
Last updated on 01. Aug 2015.
Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.3.1.
</div>
</body>
Expand Down
2 changes: 1 addition & 1 deletion doc/html/searchindex.js

Large diffs are not rendered by default.

0 comments on commit 73dae28

Please sign in to comment.