This MuPDF fork is geared towards use with Qiqqa (document and citation manager). It is based on the original MuPDF work done by Artifex, closely tracks the developments overthere and augments the codebase with other C/C++ based tools, which are useful in and around the Qiqqa document processes, such as
- text extraction
- metadata extraction (including annotations)
- OCR (text recognition as an required extension of text extraction when you have image-based PDFs, which happens quite often in the wild)
- Qiqqa database support (SQLite I/O; we do include the generic SQLite tools as well to "open up" the Qiqqa core components for advanced usage and users who wish to perform custom actions on the collected and managed data)
Currently, this fork is focused on (relatively easily) producing Windows binaries, while we stay fully aware of the need to keep this codebase cross-platform portable to Linux, etc. in order to be able to provide a viable and easy path towards Qiqqa on Linux and Qiqqa on other (UNIXy) platforms: Qiqqa issue #215
See also: https://github.com/jimmejardine/qiqqa-open-source/blob/master/DEVELOPER-INFO.md
- OS: Windows 10
- .NET 4.8, .NET 5.0 and .NET Core 3.1
- Visual Studio 2019 with
C++and.NET desktop developmentworkload.-
install the .NET SDK for .NET 4.8, .NET 5.0 and .NET Core 3.1, as available here: https://dotnet.microsoft.com/download
You'll need all three of 'em as many projects are compiled to all three targets and this spares you from build errors due to missing target environments.
-
- git or git for Windows
bash(comes as part of git packages)node(NodeJS) &npm(NodeJS Package Manager) —— preferrably installed via nvm for windowspython(Python 3)
- TortoiseGIT — UI for git
- Beyond Compare — visual comparison tool, invoked by the Unit and System Tests ApprovalTests framework.
When you intend to check this out in relation to Qiqqa, then please grab the Qiqqa repository as everything in this mupdf repository is included there as a git submodule and keeping the relative paths' relationships intact will ease your use of the entire sourcecode tree.
If you are, however, interested in this augmented mupdf material per sé, then do fork this repository itself and load the submodules we use in here to build the pdf/document tools.
When you don't want to be bothered with the (slightly bothersome)
git submodulemanagement part then, there's also a snapshot repository of this codebase plus all relevant submodules' sources available here: check that one out when you don't plan to edit this C/C++ code collection, but want to compile from source with minimum preparation / hassle.
To fetch the repository find Git Bash from Windows' start menu and run:
git clone https://github.com/GerHobbelt/mupdf.git
cd mupdf
While still in the repo's root folder, run these commands:
git config core.longpaths true
git reset --hard
This is needed because the repository includes "Windows Long Filenames". See StackOverflow.
Qiqqa/MuPDF uses several libraries and tools which are managed in separate git repositories (see the .gitmodules file).
Install/unpack the entire set using:
git submodule update --init --recursive
Warning/Note: for the full source tree, including MuPDF-based tools and experimental research material, you should invoke
git submodule update --init --recursiveBe aware that this will take a long time to download and install all source code libraries and may consume a serious chunk of your disk space, particularly when you then go and compile/run the various libraries and tools in the
MuPDFtree: the Visual Studio 2019 solution and project files will automatically copy the Tesseract data set (1+ GByte) to each binary target directory for ease of use & debugging. As you can build MuPDF in Debug and Release mode for 32 bit and 64 bit targets, that automatic action alone will account for an extra 5-6 Gbyte of disk space.However, the benefit of this approach would be far fewer surprises during initial build of the entire source tree as you won't have to selectively
git submodule update --initinstall/unpack any git submodules for your build to succeed.
-
Open
/platform/win32/mupdf.slnfile to open the project with Visual Studio 2019. -
Choose the Debug/Release 32/64-bit platform target as you like.
-
In the
Buildmenu click onBuild SolutionorRebuild Solution. This should take a while. -
Find the executables in the
/platform/win32/bin/...subdirectory, where...is the name generated for the target build you selected.
Please file an issue in this repository (or over at the Qiqqa repository; be sure to mention this repository or at least "mupdf fork" then); unless redirected by the fork maintainer(s), file trouble here before bothered Artifex: chances are we introduced a bug somewhere and it wouldn't be very polite to bother and load them with that.
MuPDF is a lightweight open source software framework for viewing and converting PDF, XPS, and E-book documents.
See the documentation in:
https://mupdf.readthedocs.io/en/latest/
Build instructions can be found in:
https://mupdf.readthedocs.io/en/latest/quick-start-guide.html
MuPDF is Copyright (c) 2006-2023 Artifex Software, Inc.
This program is free software: you can redistribute it and/or modify it under the terms of the GNU Affero General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.
This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.
You should have received a copy of the GNU Affero General Public License along with this program. If not, see http://www.gnu.org/licenses/.
For commercial licensing, including our "Indie Dev" friendly options, please contact [email protected].
The MuPDF developers hang out on Discord here:
https://discord.gg/taPnFQp5gb
Report bugs on the ghostscript bugzilla, with MuPDF as the selected component:
http://bugs.ghostscript.com/
If you are reporting a problem with a specific file, please include the file as an attachment.