Installing AMC with MacPorts on macOS

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

1 12 Joël Brogniart
h1. Installing AMC development version on macOS
2 1
3 1
This is a translation of the French entry wiki. First translation was done by Pieter Van den Hombergh.
4 13 Joël Brogniart
5 17 Joël Brogniart
_(This installation - AMC version 1.3.0 revision commit:8dc721d86584 7/17/2017 - was tested with_
6 17 Joël Brogniart
* _macOS 10.12.5 (MacPorts 2.4.1, Xcode 8.3.1)._
7 9 Joël Brogniart
8 12 Joël Brogniart
Auto Multiple Choice (AMC) is a software to manage questionnaires and multiple choice exams. It allows, from the definition of the multiple choice questions to generate sheets of questionnaires. The question types can be one only choice, multiple choices, question, right/wrong answers etc. Once the completed questionnaires are digitized, AMC automatically corrects the questionnaires. This software runs in a graphical environment X Window System on Linux and macOS. Linux is used as the develop environment, so it probably runs best there. Your mileage may vary.
9 1
10 9 Joël Brogniart
In previous versions of this note, the source code of all necessary files were shown. As these sources are provided in the associated archive and not to burden the instructions, source code no longer appear in the note.
11 10 Joël Brogniart
12 9 Joël Brogniart
It is possible to install the "1.1.2 pre-compiled version":http://project.auto-multiple-choice.net/projects/auto-multiple-choice/wiki/Installation_d'AMC_sous_OS_X , but you would miss the newest developments happening in this active project. You can also install from the source, directly from the development  repository. This will give you the bleeding edge version.
13 10 Joël Brogniart
14 12 Joël Brogniart
For the moment, this installation guide is quite technical and has only been tested on macOS 10.11.5, 10.10.5 and 10.9.5 with the corresponding latest version of Xcode. You will need "MacPorts":http://www.macports.org, a little understanding of the dependencies between different tools (Subversion, MacPorts, PERL, X11, port ...) and the macOS architecture. You should also have administrative rights on the computer. This manual is therefore unfortunately not for everyone.
15 9 Joël Brogniart
16 1
For this installation you will create a local MacPort repository. In this repository you will add macports description for AMC and possibly files for additional ports. Once these files are installed, the installation of AMC can be started.
17 1
18 1
h2. Prerequisites
19 9 Joël Brogniart
20 1
The requirements are the same as the installation of version 1.1.2 AMC. To work with the interface, AMC requires the graphical environment X Window System and X11, the Linux Libertine font, the DejaVu font family and the MacPorts installation system.
21 1
22 12 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.
23 7 Joël Brogniart
24 1
h3. MacPorts
25 1
26 12 Joël Brogniart
MacPorts is a system to build, install and manage open source software. You need to download the macOS Yosemite installation package on the site "MacPorts":http://www.macports.org and install MacPorts.
27 1
28 1
h3. Linux Libertine font
29 9 Joël Brogniart
30 1
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 "LinuxLibertine.org":http://www.linuxlibertine.org site.
31 9 Joël Brogniart
32 12 Joël Brogniart
*Caution* : The current version of XQuartz (2.7.11) does not recognize the fonts installed in the user's folder. You must install the fonts by moving them in the "@/Library/Fonts@" folder.
33 9 Joël Brogniart
34 9 Joël Brogniart
h3. DejaVu font family
35 9 Joël Brogniart
36 9 Joël Brogniart
DejaVu fonts are used for japanese documentation generation.
37 9 Joël Brogniart
 Ces polices sont utilisées pour la génération des documentations en japonais. You need to download the fonts on "dejavu-fonts.org":http://dejavu-fonts.org/wiki/Download site.
38 9 Joël Brogniart
39 12 Joël Brogniart
*Caution* : The current version of XQuartz (2.7.11) does not recognize the fonts installed in the user's folder. You must install the fonts by moving them in the "@/Library/Fonts@" folder.
40 1
41 7 Joël Brogniart
h2. MacPorts installation (port) files
42 7 Joël Brogniart
43 2 Joël Brogniart
The MacPorts port file contains information that allows a program to be installed into the MacPorts system. It shows what tools are needed for installation and operation of the program and how to install the program. 
44 1
MacPorts contains "many ports":http://www.macports.org/ports.php but it does not contain a port describing the AMC installation from the source code of the program. So we have to create the file port for the development version of AMC.
45 4 Joël Brogniart
46 7 Joël Brogniart
To avoid conflicts with ports already described in MacPorts, new ports will be installed in the folders of the user who installs, instead of being installed in folders directly managed by MacPorts.
47 4 Joël Brogniart
48 7 Joël Brogniart
h3. Local MacPorts repository
49 7 Joël Brogniart
50 1
For MacPorts to use a local folder, you must create that local folder.
51 1
52 1
<pre>mkdir -p ~/nix</pre>
53 1
54 7 Joël Brogniart
You should then tell MacPorts to take the local folder into account, before considering the standard hierarchy MacPorts. To do this you must edit the file "@/opt/local/etc/macports/sources.conf@" and add a URL to the local file before the URL of the repository @rsync@ MacPorts.
55 9 Joël Brogniart
56 7 Joël Brogniart
<pre>file:///Users/julesvernes/nix/macports
57 1
rsync://rsync.macports.org/release/tarballs/ports.tar [default]</pre>
58 1
59 1
h3. Port Files
60 1
61 14 Joël Brogniart
Two archives containing the port files are available for download:
62 1
* for installation on OS X 10.9 and 10.10 attachment:macports-10.10.zip,
63 14 Joël Brogniart
* for installation on macOS 10.11 and 10.12 attachment:macports-10.12.zip.
64 12 Joël Brogniart
65 14 Joël Brogniart
First archive contains only AMC port description. Archive for macOS 10.11 and 10.12 includes an adaptation of ports @gcc5@ and @pdftk@ to make them working under these versions of macOS.
66 12 Joël Brogniart
67 4 Joël Brogniart
Download and uncompress this archive then move the "@macports@" folder inside the previously created folder.
68 4 Joël Brogniart
69 4 Joël Brogniart
!port-hierarchy.png!
70 7 Joël Brogniart
71 1
Each directory must contain a port document named @Portfile@. This document is a text document containing a description for the MacPorts installation tool.
72 1
73 9 Joël Brogniart
h4. Excerpt for @x11/auto-multiple-choice-devel/Portfile@
74 1
<pre title="x11/auto-multiple-choice-devel/Portfile"># -*- coding: utf-8; mode: tcl; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- vim:fenc=utf-8:ft=tcl:et:sw=4:ts=4:sts=4
75 4 Joël Brogniart
76 1
PortSystem              1.0
77 1
PortGroup               bitbucket 1.0
78 1
PortGroup               perl5 1.0
79 15 Joël Brogniart
PortGroup               texlive 1.0
80 9 Joël Brogniart
81 17 Joël Brogniart
set bitbucket_commit    "8dc721d86584"
82 17 Joël Brogniart
set amc_revision        "2075"
83 17 Joël Brogniart
#2075:8dc721d86584
84 4 Joël Brogniart
bitbucket.setup         auto-multiple-choice auto-multiple-choice ${bitbucket_commit}
85 9 Joël Brogniart
name                    auto-multiple-choice-devel
86 7 Joël Brogniart
version                 1.3.${amc_revision}
87 4 Joël Brogniart
categories              x11 tex education
88 1
platforms               darwin
89 1
license                 GPL-2+
90 7 Joël Brogniart
maintainers             laposte.fr:joel.brogniart,openmaintainer
91 7 Joël Brogniart
92 7 Joël Brogniart
description             Auto Multiple Choice - Multiple Choice Papers Management
93 7 Joël Brogniart
long_description        Utility to manage multiple choice questionnaires, \
94 1
                        with optionally mixed questions and answers. \
95 1
                        AMC provides automatic marking from papers' scans. \
96 1
                        Annotated papers are produced. Marks can be exported \
97 4 Joël Brogniart
                        as an OpenOffice.org sheet file.
98 9 Joël Brogniart
99 17 Joël Brogniart
homepage                http://www.auto-multiple-choice.net/
100 15 Joël Brogniart
conflicts               auto-multiple-choice
101 14 Joël Brogniart
102 17 Joël Brogniart
checksums               rmd160  90cebf01f59dcba945d5de6d97593f80f8664743 \
103 17 Joël Brogniart
                        sha256  95f74839c81945c455e9e02e524350fd081e075355feaaf2923063f69f35f1d3
104 9 Joël Brogniart
105 4 Joël Brogniart
depends_build-append    \
106 1
                        port:dblatex \
107 4 Joël Brogniart
                        port:p${perl5.major}-xml-libxml
108 7 Joël Brogniart
</pre>
109 1
110 10 Joël Brogniart
h2. Installing AMC
111 10 Joël Brogniart
112 10 Joël Brogniart
Once the port files set up, generate the index of the new port.
113 10 Joël Brogniart
<pre>cd ~/nix/macports
114 11 Joël Brogniart
portindex</pre>
115 12 Joël Brogniart
116 11 Joël Brogniart
*Warning*: standard and development of AMC versions can't be installed simultaneously. If a standard version was previously installed, you must uninstall it before installing the development version.
117 12 Joël Brogniart
118 10 Joël Brogniart
<pre>sudo port uninstall auto-multiple-choice</pre>
119 7 Joël Brogniart
120 5 Joël Brogniart
Finally install AMC.
121 7 Joël Brogniart
122 5 Joël Brogniart
<pre>sudo port install auto-multiple-choice-devel</pre>
123 5 Joël Brogniart
124 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.
125 5 Joël Brogniart
126 5 Joël Brogniart
h2. Using AMC
127 7 Joël Brogniart
128 5 Joël Brogniart
You can start from the terminal or from XQuartz.
129 7 Joël Brogniart
130 5 Joël Brogniart
h3. In the Terminal
131 5 Joël Brogniart
132 5 Joël Brogniart
<pre>auto-multiple-choice</pre>
133 7 Joël Brogniart
134 5 Joël Brogniart
This command will launch XQuartz and AMC application.
135 5 Joël Brogniart
136 5 Joël Brogniart
h3. In XQuartz
137 5 Joël Brogniart
138 7 Joël Brogniart
Start XQuartz application.
139 5 Joël Brogniart
140 1
!xquartz.png!
141 5 Joël Brogniart
142 5 Joël Brogniart
We can immediately set XQuartz to facilitate the launch of AMC. Open the @Applications > Customize...@ menu.
143 7 Joël Brogniart
144 7 Joël Brogniart
!xquartz-menu-applications-personnaliser.png!
145 5 Joël Brogniart
146 5 Joël Brogniart
In the Personalization window, click the button @Add an entry@.
147 7 Joël Brogniart
148 5 Joël Brogniart
!xquartz-fenetre-personnaliser-menu-applications.png!
149 7 Joël Brogniart
150 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.
151 7 Joël Brogniart
152 5 Joël Brogniart
!xquartz-fenetre-personnaliser-menu-applications-2.png!
153 7 Joël Brogniart
154 5 Joël Brogniart
Close the Customize window, then select the @Applications > Auto Multiple Choice@ menu.
155 5 Joël Brogniart
156 5 Joël Brogniart
!xquartz-menu-applications-amc.png!
157 7 Joël Brogniart
158 5 Joël Brogniart
AMC window should appear.
159 7 Joël Brogniart
160 5 Joël Brogniart
!auto-multiple-choice-window.png!
161 5 Joël Brogniart
162 5 Joël Brogniart
Auto-multiple-choice is now ready to work.
163 5 Joël Brogniart
164 7 Joël Brogniart
h2. Links
165 5 Joël Brogniart
166 12 Joël Brogniart
* Auto Multiple Choice, "http://home.gna.org/auto-qcm/":http://home.gna.org/auto-qcm/.
167 5 Joël Brogniart
* Auto Multiple Choice, "Installation sous macOS (10.8)":http://project.auto-multiple-choice.net/projects/auto-multiple-choice/wiki/Installation_d'AMC_sous_OS_X_Mountain_Lion.
168 5 Joël Brogniart
* MacPorts, "http://www.macports.org":http://www.macports.org.
169 1
* MacPorts, "Local Portfile Repositories":http://guide.macports.org/#development.local-repositories.
170 1
* MacPorts, "How to create portfiles for CPAN Perl modules":https://trac.macports.org/wiki/howto/cpan2port.
171 1
* XQuartz, http://xquartz.macosforge.org</a>.