Installing AMC with MacPorts on macOS

Version 24 (Joël Brogniart, 03/23/2024 09:13 am)

1 20 Joël Brogniart
h1. Installing AMC on macOS
2 1
3 20 Joël Brogniart
The installation guide requires some knowledge about Unix tools, the use of command lines, the installation of "MacPorts":http://www.macports.org. You must also have administrative rights on the computer. It is therefore not intended for everyone.
4 10 Joël Brogniart
5 9 Joël Brogniart
h2. Prerequisites
6 1
7 20 Joël Brogniart
To work with its interface, AMC requires an X Window System or X11 graphical environment, the Linux Libertine font, the DejaVu font family, and the MacPorts installation system.
8 1
9 20 Joël Brogniart
h3. X Window System environment
10 1
11 20 Joël Brogniart
MacOS does not contain the standard X11 graphical environment. It is possible to fill this gap by installing XQuartz, an X Windows System environment running macOS. You can download the application on the XQuartz site. "XQuartz":http://xquartz.macosforge.org.
12 12 Joël Brogniart
13 1
h3. Linux Libertine font
14 7 Joël Brogniart
15 24 Joël Brogniart
Linux Libertine font is a free font that covers code pages for Latin languages​​, Greek, Cyrillic languages​​, Hebrew, the International Phonetic Alphabet (and other). You need to download the package "OTF" on "sourceforge":https://sourceforge.net/projects/linuxlibertine/ site.
16 1
17 20 Joël Brogniart
*Caution* : XQuartz does not recognize the fonts installed in the user's folder. You must install the fonts by moving them in the "@/Library/Fonts@" folder.
18 1
19 12 Joël Brogniart
h3. DejaVu font family
20 1
21 24 Joël Brogniart
DejaVu fonts are used for generating documentation in Japanese. You need to download the fonts on "sourceforge":https://sourceforge.net/projects/dejavu/ site.
22 1
23 20 Joël Brogniart
*Caution* : XQuartz does not recognize the fonts installed in the user's folder. You must install the fonts by moving them in the "@/Library/Fonts@" folder.
24 1
25 20 Joël Brogniart
h3. MacPorts
26 1
27 20 Joël Brogniart
MacPorts is a system that compiles, installs and manages open source software. You need to download the installation package for your version of macOS from the "MacPorts":http://www.macports.org and install MacPorts. Follow the instructions carefully and don't forget to install Xcode.
28 1
29 20 Joël Brogniart
h2. Installing AMC
30 9 Joël Brogniart
31 23 Joël Brogniart
It is possible to install one of the two versions of AMC. Either the @stable@ version (currently, version 1.3.0.2141 of 26/12/2017), or the @development@ version. The @stable@ version evolves slowly and version changes are infrequent. Several months or years may pass between two version changes. The @development@ version is subject to more frequent changes. Some of the new features have not been fully tested and may not work as expected.
32 7 Joël Brogniart
33 20 Joël Brogniart
It is not possible to install both the @stable@ and the @development@ version. If one of these versions is installed, you must uninstall it before installing the other version.
34 20 Joël Brogniart
35 23 Joël Brogniart
For installation and operation AMC requires a @LaTeX@ environment. The standard installation will use MacPorts to install this environment. If you are using "MacTeX":http://www.tug.org/mactex/ and want AMC to use @MacTeX@ instead of the MacPort environment, the installation process differs from the standard installation. You should follow either the instructions of the standard installation, or those of the installation of a version of AMC using MacTeX. These descriptions assume that you have a fresh and up-to-date MacPorts installation.
36 15 Joël Brogniart
37 20 Joël Brogniart
h3. Standard installation
38 19 Joël Brogniart
39 20 Joël Brogniart
The standard installation uses MacPorts to install the LaTeX environment needed by AMC. Use the following command to install the @stable@ version of AMC.
40 20 Joël Brogniart
<pre>sudo port install auto-multiple-choice</pre>
41 4 Joël Brogniart
42 20 Joël Brogniart
Or use the following command to install the @development@ version of AMC.
43 20 Joël Brogniart
<pre>sudo port install auto-multiple-choice-devel</pre>
44 7 Joël Brogniart
45 20 Joël Brogniart
h3. Installing AMC for use with MacTeX
46 10 Joël Brogniart
47 20 Joël Brogniart
MacPorts build tools must be able to access MacTeX tools. For example, with the MacTeX 2017 installation, these tools are available in the @"/Library/TeX/texbin"@ folder. The MacPorts configuration needs to be changed to include this folder in MacPorts @path@.
48 10 Joël Brogniart
49 20 Joël Brogniart
Be careful, as noted in the "MacPorts documentation":https://guide.macports.org/chunked/internals.configuration-files.html, changing MacPorts' @path@ can have unpredictable effects and consequences for others tools. It must be avoided.
50 11 Joël Brogniart
51 20 Joël Brogniart
Edit the @/opt/local/etc/macports/macports.conf@ file to add the following line.
52 20 Joël Brogniart
<pre>binpath               /opt/local/bin:/opt/local/sbin:/bin:/sbin:/usr/bin:/usr/sbin:/Library/TeX/texbin</pre>
53 12 Joël Brogniart
54 20 Joël Brogniart
For the stable version of AMC, you must start the installation with the following command.
55 20 Joël Brogniart
<pre>sudo port install auto-multiple-choice +mactex</pre>
56 5 Joël Brogniart
57 20 Joël Brogniart
And for the development version of AMC it is necessary to use the command which follows.
58 20 Joël Brogniart
<pre>sudo port install auto-multiple-choice-devel +mactex</pre>
59 5 Joël Brogniart
60 5 Joël Brogniart
The installation may take a while. When it is complete and if there is no error, AMC is ready to be used.
61 5 Joël Brogniart
62 5 Joël Brogniart
h2. Using AMC
63 7 Joël Brogniart
64 5 Joël Brogniart
You can start from the terminal or from XQuartz.
65 7 Joël Brogniart
66 5 Joël Brogniart
h3. In the Terminal
67 5 Joël Brogniart
68 5 Joël Brogniart
<pre>auto-multiple-choice</pre>
69 7 Joël Brogniart
70 5 Joël Brogniart
This command will launch XQuartz and AMC application.
71 5 Joël Brogniart
72 5 Joël Brogniart
h3. In XQuartz
73 5 Joël Brogniart
74 7 Joël Brogniart
Start XQuartz application.
75 5 Joël Brogniart
76 1
!xquartz.png!
77 5 Joël Brogniart
78 5 Joël Brogniart
We can immediately set XQuartz to facilitate the launch of AMC. Open the @Applications > Customize...@ menu.
79 7 Joël Brogniart
80 7 Joël Brogniart
!xquartz-menu-applications-personnaliser.png!
81 5 Joël Brogniart
82 5 Joël Brogniart
In the Personalization window, click the button @Add an entry@.
83 7 Joël Brogniart
84 5 Joël Brogniart
!xquartz-fenetre-personnaliser-menu-applications.png!
85 7 Joël Brogniart
86 5 Joël Brogniart
Set "@Auto Multiple Choice@" in the @Name@ column and "@auto-multiple-choice@" in the @Command@ column of the new menu item.
87 7 Joël Brogniart
88 5 Joël Brogniart
!xquartz-fenetre-personnaliser-menu-applications-2.png!
89 7 Joël Brogniart
90 5 Joël Brogniart
Close the Customize window, then select the @Applications > Auto Multiple Choice@ menu.
91 5 Joël Brogniart
92 5 Joël Brogniart
!xquartz-menu-applications-amc.png!
93 7 Joël Brogniart
94 5 Joël Brogniart
AMC window should appear.
95 7 Joël Brogniart
96 5 Joël Brogniart
!auto-multiple-choice-window.png!
97 5 Joël Brogniart
98 5 Joël Brogniart
Auto-multiple-choice is now ready to work.
99 5 Joël Brogniart
100 7 Joël Brogniart
h2. Links
101 5 Joël Brogniart
102 24 Joël Brogniart
* DejaVu fonts, "https://sourceforge.net/projects/dejavu/":https://sourceforge.net/projects/dejavu/
103 24 Joël Brogniart
* Linux Libertine font, "https://sourceforge.net/projects/linuxlibertine/":https://sourceforge.net/projects/linuxlibertine/
104 1
* MacPorts, "http://www.macports.org":http://www.macports.org.
105 22 Joël Brogniart
* MacTeX, "http://www.tug.org/mactex/":http://www.tug.org/mactex/
106 22 Joël Brogniart
* XQuartz, "http://xquartz.macosforge.org":http://xquartz.macosforge.org.