Installer la documentation sur des ordinateurs continuellement hors ligne

Depuis R2023a

Lorsque vous utilisez MATLAB^®, vous accédez par défaut à la documentation du produit en ligne. Pour utiliser la documentation sur un ordinateur qui est continuellement hors ligne, vous pouvez la télécharger, la copier sur l’ordinateur hors ligne et l’installer sur ce dernier.

Si vous utilisez habituellement MATLAB tout en étant connecté à Internet et ne travaillez que rarement hors ligne, reportez-vous à la section Installer la documentation pour une utilisation hors ligne.

Conditions préalables

Dans cette procédure, vous allez télécharger une image ISO (Windows^® et Linux^®) ou DMG (macOS) de la documentation et vous allez la monter sur l’ordinateur hors ligne. Une connaissance des concepts informatiques est recommandée mais pas obligatoire.
L’ordinateur utilisé pour télécharger la documentation doit disposer d’une connexion Internet.
Pour télécharger la documentation, vous devez avoir un compte MathWorks^®. L’installation de la documentation sur l’ordinateur hors ligne ne nécessite pas de compte MathWorks.
L’ordinateur utilisé pour télécharger la documentation et l’ordinateur hors ligne doivent tous deux disposer de plus de 10 Go d’espace disque pour stocker l’image ISO ou DMG de la documentation.
MATLAB doit déjà être installé sur l’ordinateur hors ligne.

Télécharger la documentation (nécessite une connexion Internet)

Pour télécharger la documentation pour R2024a, sélectionnez le système d’exploitation de l’ordinateur hors ligne cible dans la liste Operating Systems affichée ici. Cliquez ensuite sur Download documentation.

Connectez-vous pour télécharger la documentation

Pour télécharger la documentation pour d’autres versions, procédez comme suit :

Sur la page Téléchargements MathWorks, dans la liste Select Release, sélectionnez la version que vous souhaitez télécharger.
Dans la liste I Want To, sélectionnez Get ISOs and DMGs.
Développez Get MATLAB and Simulink Product Documentation.
Cliquez sur le lien Learn more pour accéder aux instructions de téléchargement et d’installation de la documentation de la version sélectionnée. Suivez ces instructions plutôt que celles de la présente page.

Copier la documentation sur l’ordinateur hors ligne

Copiez l’image ISO ou DMG de la documentation téléchargée sur l’ordinateur hors ligne en utilisant un support média amovible ou un emplacement réseau partagé. Sur l’ordinateur hors ligne, montez ensuite l’image ISO ou DMG de la documentation en suivant la procédure standard pour votre plateforme. Pour en savoir plus, consultez la page Comment installer les produits MathWorks à l'aide d'une image ISO ou DMG ?

Installer la documentation sur l’ordinateur hors ligne

Installez la documentation sur l’ordinateur hors ligne avec l’outil mpm exécutable en ligne de commande. mpm est inclus dans l’image ISO ou DMG de la documentation téléchargée.

Remarque

Exécutez les étapes qui suivent à partir de la ligne de commande de votre système d’exploitation. N’exécutez pas ces commandes à partir de MATLAB.

À partir de la ligne de commande du système d’exploitation, accédez au dossier contenant le programme d’installation de la documentation dans l’image montée.
```
cd mountedDocImage/bin/arch
```
- mountedDocImage est le répertoire racine de l'image ISO ou DMG montée de la documentation.
- arch est le dossier d'architecture du système d'exploitation de l'image ISO, tel que win64, glnxa64, maci64 ou maca64.
Exécutez le programme d’installation de la documentation avec la commande mpm install-doc. Spécifiez l’option --matlabroot pour définir le dossier où est installé MATLAB sur l’ordinateur hors ligne.
Windows
Syntaxe :
```
.\mpm install-doc --matlabroot=matlabroot
```
Exemple :
```
.\mpm install-doc --matlabroot="C:\Program Files\MATLAB\R2024a"
```
Si le chemin matlabrootfolder contient des espaces, mettez-le entre guillemets comme indiqué dans l’exemple.
Linux ou macOS
Syntaxe :
```
./mpm install-doc --matlabroot=matlabrootfolder
```
Exemple :
```
./mpm install-doc --matlabroot=/home/username/matlab
```
Par défaut, mpm installe la documentation dans le dossier racine du support package au sein de MATLAB. Pour trouver la racine du support package, utilisez la fonction matlabshared.supportpkg.getSupportPackageRoot.
Pour spécifier un emplacement différent pour la documentation, utilisez l’option --destination. Si vous montez l’image ISO ou DMG de la documentation à un autre emplacement que celui où vous avez installé MATLAB, par exemple sur un lecteur réseau, utilisez l’option --source pour indiquer le chemin d’accès complet aux fichiers du programme d’installation.
Windows
```
.\mpm install-doc --matlabroot=matlabrootfolder --source=docinstallfolder --destination=destinationfolder
```
Linux ou macOS
```
./mpm install-doc --matlabroot=matlabrootfolder --source=docinstallfolder --destination=destinationfolder
```
Remarque
Si l’erreur Conflicting release versions s’affiche pendant l’installation, vérifiez que l’image ISO ou DMG de la documentation correspond à la même version que le logiciel MATLAB installé sur l’ordinateur hors ligne. Le nom de la version est inclus dans le nom de fichier de l’image ISO ou DMG.
Démontez l’image ISO ou DMG de la documentation. Si vous devez récupérer l’espace disque, supprimez l’image.

Configurer MATLAB pour utiliser la documentation installée

Mettez à jour les préférences MATLAB pour que MATLAB ouvre la documentation installée au lieu de la documentation en ligne.

Ouvrez MATLAB.
Dans l’onglet Home, et la section Environment, cliquez sur Preferences.
Dans le volet gauche de la boîte de dialogue « Preferences », cliquez sur MATLAB puis sur Help.
Sous Documentation Location, sélectionnez Installed locally.
Cette étape n’est nécessaire que si vous avez installé la documentation ailleurs qu’à l’emplacement par défaut avec l’indicateur --destination.
Mettez à jour le répertoire racine de la documentation pour que MATLAB pointe vers l’emplacement où celle-ci est installée.
1. Ouvrez le fichier MATLAB startup.m. Si ce fichier n’existe pas, créez un fichier vide portant ce nom. Les commandes spécifiées dans ce fichier s’exécutent au démarrage de MATLAB. Pour plus de détails sur les fichiers startup.m, consultez la section Startup Options in MATLAB Startup File.
2. Dans votre fichier startup.m, ajoutez cette ligne pour définir le répertoire racine de la documentation sur le nouvel emplacement de cette dernière. newDocInstallFolder est le chemin d’accès au dossier où vous avez installé la documentation.
  docroot('newDocInstallFolder/help')
3. Redémarrez MATLAB.

Vérifier l’installation locale

Vérifiez que la documentation s’ouvre en local. À l’invite de commande MATLAB, saisissez : doc

Si la page d’accueil de la documentation s’ouvre, placez le curseur sur l’un des liens qu’elle contient et vérifiez le format de l’URL qui s’affiche dans le coin inférieur gauche. Si l’URL est un chemin de fichier local (par exemple file:///C:/ProgramData/MATLAB/...), cela signifie que MATLAB ouvre la documentation locale.
Si la page qui s’ouvre est vide ou si les URL de la page d’accueil de la documentation affichent des chemins d’accès au web (par exemple https://www.mathworks.com/help/...), cela signifie que MATLAB ouvre toujours la documentation en ligne. Mettez à jour MATLAB pour pointer vers la documentation installée en local comme décrit dans Configurer MATLAB pour utiliser la documentation installée.

Mettre à jour la documentation sur l’ordinateur hors ligne

Pour mettre à jour la documentation installée après l’ajout ou la suppression de produits ou pour installer la documentation la plus récente, répétez les procédures précédentes.