1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191
|
.. |TexText| replace:: **TexText**
.. |Inkscape| replace:: **Inkscape 1.4**
.. |InkscapeOld| replace:: **Inkscape 0.92.x**
.. role:: bash(code)
:language: bash
:class: highlight
.. role:: latex(code)
:language: latex
:class: highlight
.. _macos-install:
==================
|TexText| on MacOS
==================
.. _macos-install-preparation:
.. attention::
Inkscape for MacOS is shipped as a :bash:`dmg`-file from the Inkscape
website. However, on some systems the extensions and Python subsystem
shipped together with this installer seems to be broken. This is a problem
of Inkscape development, not of |TexText|. Hence, two
alternative approaches are shown here together with some steps how to
setup a Python installation which works together with the Inkscape extension
system.
Help us and other MacOS users by posting an
`issue on github <https://github.com/textext/textext/issues/new/choose>`_
if something goes wrong or you have ideas how to improve the procedure!
Method 1: Use Inkscape DMG installer (optionally together with Homebrew Python)
-------------------------------------------------------------------------------
1. Install Inkscape: Download the installer from the
`Inkscape download site <https://inkscape.org/release>`_.
2. Install Inkscape. Verify that Inkscape launches and is of version
1.4.
3. Make sure you have a functional LaTeX distribution (providing at least the
pdflatex binary) and/or a typst binary.
4. Download the most recent package of |TexText| from
:textext_current_release_page:`release`
(direct link: :textext_download_zip:`MacOS`). In case you are still using
Inkscape 1.2, 1.1, or 1.0 download
`TexText 1.8.2 <https://github.com/textext/textext/releases/tag/1.8.2>`_!
Extract the package and change into the created directory.
5. Next we try to install and run |TexText|. If the installation or the launch
of |TexText| fails a method is shown how to fix the problem.
Run:
.. code-block:: bash
python3 setup.py --pdflatex-executable=$(which pdflatex) --skip-requirements-check
or
.. code-block:: bash
python setup.py --pdflatex-executable=$(which pdflatex) --skip-requirements-check
The script will copy the required files into the user's Inkscape
configuration directory (usually this is ``~/Library/Application Support/org.inkscape.Inkscape/config/inkscape/extensions``)
See :ref:`advanced-install` for further options provided by
:bash:`setup.py`.
6. Launch Inkscape and try to run |TexText| (Consult the :ref:`usage instructions <gui>`).
If |TexText| fails to launch go to step 6. Otherwise you are done.
7. The Python installation shipped together with Inkscape seems to be broken. Hence,
we need to install one manually. Assuming you have Homebrew installed, install
Python 3.9:
.. code-block:: bash
brew install python@3.9
8. Then install the Tkinter GUI-library, NumPy and PyGObject:
.. code-block:: bash
brew install python-tk@3.9
brew install numpy
brew install pygobject3
9. Install the lxml-tools and cssselect required by the Inkscape extensions:
.. code-block:: bash
$(brew --prefix)/opt/python@3.9/libexec/bin/pip install lxml
$(brew --prefix)/opt/python@3.9/libexec/bin/pip install cssselect
10. Determine the path of the Homebrew python3 executable:
.. code-block:: bash
which $(brew --prefix)/opt/python@3.9/libexec/bin/python3
11. Navigate into the directory
:bash:`/Users/<your username>/Library/Application Support/org.inkscape.Inkscape/config/inkscape`.
(Replace <your username> by your MacOS user name)
12. Open the file :bash:`preferences.xml` and navigate to the line that says
:bash:`id="extensions"`. Add a line :bash:`python-interpreter="<python path>"`
where :bash:`<python path>` has to be replaced by the path determined in step 9.
After this operation the entry should look like this:
.. code-block:: xml
<group
id="extensions"
python-interpreter="<python path>"
/>
13. If the installation of |TexText| in step 4 failed try to install it with the
following command, otherwise go to step 13:
.. code-block:: bash
$(brew --prefix)/opt/python@3.9/libexec/bin/python3 setup.py --pdflatex-executable=$(which pdflatex) --skip-requirements-check
14. Launch Inkscape and try to run |TexText|. In case of success you should see at least
the Tkinter GUI which is a simplified version of the GTK gui described in the
:ref:`usage instructions <gui>`.
.. note::
In case of installation problems refer to the :ref:`trouble_installation` in the :ref:`troubleshooting` section!
If this still does not help open an `issue on github <https://github.com/textext/textext/issues/new/choose>`_.
However, please note the the TexText-maintainers do not have access to a MacOS system. So
we need your direct cooperation to improve the installation instructions.
Method 2: Use Homebrew Inkscape
-------------------------------
Preparation
===========
1. Install inkscape
.. code-block:: bash
brew install --cask inkscape
Verify that inkscape launches and is of version >= 1.4
2. Make sure you have a functional LaTeX distribution and/or typst binary.
.. _macos-install-textext:
Download and install |TexText|
==============================
1. Download the most recent package from :textext_current_release_page:`GitHub release page <release>`
(direct link: :textext_download_zip:`MacOS`)
2. Extract the package and change into the created directory.
3. Run:
.. code-block:: bash
python3 setup.py --pdflatex-executable=$(which pdflatex) --skip-requirements-check
or
.. code-block:: bash
python setup.py --pdflatex-executable=$(which pdflatex) --skip-requirements-check
The script will copy the required files into the user's Inkscape
configuration directory (usually this is ``~/Library/Application Support/org.inkscape.Inkscape/config/inkscape/extensions``)
If installation fails or TexText does not launch proceed with step 6 in method 1.
See :ref:`advanced-install` for further options provided by
:bash:`setup.py`.
Now you can consult the :ref:`usage instructions <gui>`.
|