Preferences

Description

Le comportement de uman peut être modifié par un jeu de paramètres réglables via l'interface interactive des préférences de Scilab, dans la section Toolboxes/uman.

Les valeurs des paramètres de préférences de uman() sont enregistrées dans le fichier SCIHOME/uman_preferences.xml. Ce fichier est automatiquement créé lors de la 1ère utilisation de uman ≥ 3.0

Sommaire

Paramètres disponibles

Longueur maximale des lignes Entier décimal dans [50, 110]. Toute valeur hors de cet intervalle est ignorée. Valeur par défaut = 90. Lorsque la console est large, ce paramètre permet de limiter la longueur des lignes effectivement affichées, sans atteindre le bord droit de la console, afin d'en améliorer la lisibilité. Si la console est plus étroite que MaxLinesWidth, sa largeur est utilisée comme limite.
Autoriser les tableaux larges Lorsque cette option est activée, l'affichage des tableaux multicolonnes larges peut dépasser la limite MaxLinesWidth, mais toujours dans la limite de la largeur de la console. Cela permet de limiter la fréquence des césures des lignes dans les cellules te tableau particulièrement chargées, lesquelles lignes sont déjà naturellement plus courtes qu'en pleine page. Exemple avec lines()(1)==109 et umanMaxLinesWidth==90 : ... sans autoriser les tableaux larges : -->//~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ Bord de la console >>>>| --> uman EXTRACTBITS e ... Exemples -------- Le tableau suivant présente les résultats obtenus pour le nombre 215 en fonction de plusieurs combinaisons de paramètres. --------------------------------------------------------------------------------------- | Entrée | Bits à extraire| Nombre de bits ou| Treat Bit Field| Sortie | | | | n° de bit | as an Integer | | | 11010111 (215)| Upper Half | Ignoré | non | 01100000 (208) | | 11010111 (215)| Upper Half | Ignoré | oui | 00001101 (13) | | 11010111 (215)| Lower Half | Ignoré | non | 00000111 (7) | | 11010111 (215)| Lower Half | Ignoré | oui | 00000111 (7) | | 11010111 (215)| Range starting | 6 | non | 11010100 (212) | | | with MSB | | | | | 11010111 (215)| Range starting | 6 | oui | 00110101 (53) | | | with MSB | | | | | 11010111 (215)| Range starting | 6 | non | 00010111 (23) | | | with LSB | | | | | 11010111 (215)| Range starting | 6 | oui | 00010111 (23) | | | with LSB | | | | | 11010111 (215)| Range of bits | [ 2, 5 ] | non | 00010100 (20) | | 11010111 (215)| Range of bits | [ 2, 5 ] | oui | 00000101 (5) | | 11010111 (-41)| Upper half | Ignoré | non | 11010000 (-48) | | 11010111 (-48)| Upper half | Ignoré | oui | 11111101 (-3) | --------------------------------------------------------------------------------------- Dans le schéma suivant, deux chiffres décimaux sont codés sur un seul octet. Le diagramme décode l'entrée pour obtenir deux chiffres séparés. ... ... puis après avoir coché Autoriser les tableaux larges : --> uman EXTRACTBITS e ... Exemples -------- Le tableau suivant présente les résultats obtenus pour le nombre 215 en fonction de plusieurs combinaisons de paramètres. ----------------------------------------------------------------------------------------------------------- | Entrée | Bits à extraire | Nombre de bits ou n° de| Treat Bit Field as an| Sortie | | | | bit | Integer | | | 11010111 (215)| Upper Half | Ignoré | non | 01100000 (208) | | 11010111 (215)| Upper Half | Ignoré | oui | 00001101 (13) | | 11010111 (215)| Lower Half | Ignoré | non | 00000111 (7) | | 11010111 (215)| Lower Half | Ignoré | oui | 00000111 (7) | | 11010111 (215)| Range starting with MSB| 6 | non | 11010100 (212) | | 11010111 (215)| Range starting with MSB| 6 | oui | 00110101 (53) | | 11010111 (215)| Range starting with LSB| 6 | non | 00010111 (23) | | 11010111 (215)| Range starting with LSB| 6 | oui | 00010111 (23) | | 11010111 (215)| Range of bits | [ 2, 5 ] | non | 00010100 (20) | | 11010111 (215)| Range of bits | [ 2, 5 ] | oui | 00000101 (5) | | 11010111 (-41)| Upper half | Ignoré | non | 11010000 (-48) | | 11010111 (-48)| Upper half | Ignoré | oui | 11111101 (-3) | ----------------------------------------------------------------------------------------------------------- Dans le schéma suivant, deux chiffres décimaux sont codés sur un seul octet. Le diagramme décode l'entrée pour obtenir deux chiffres séparés. ...
Options d'appel par défaut Le Chemin > dans > l'aide, le bloc de Syntaxes, et la section Voir aussi sont toujours affichés par défaut. Ce paramètre permet d'indiquer les options d'appel à utiliser par défaut, à la place des valeurs par défaut "par défaut". Pour ce faire, indiquer un ou plusieurs caractères représentant les options choisies, telles que décrites dans la page uman principale : "p" pour la section Paramètres = Arguments, "d" pour la section Description (ou autres sections non identifiables), "e" pour la section des Exemples, "h" pour l'Historique, "l##" pour indiquer la langue, etc. Remarques : Lorque "l##" est spécifié, il est préférable de l'indiquer en dernière option. Les options "w", "b" et "@" sont ici ignorées. Le mode uman par défaut est toujours le mode d'affichage en console. L'option "r" est ici également ignorée. "j" peut être indiquée pour systématiquement alimenter les journaux de session éventuellement ouverts, avec les résultats console des appels à uman. "x" est utilisable en option par défaut. Elle peut aider les nouveaux utilisateurs de Scilab venant d'Octave ou de Matlab. Cependant, on devra garder à l'esprit qu'il n'existe pas d'option d'appel explicite permettant de suspendre l'option "x". "s" indiquée en option par défaut est neutralisée par les options p | d | e | h | a | u utilisées à l'appel de uman. "u" indiquée en option par défaut est neutralisée par p | d | e | h | a | s utilisées à l'appel de uman.
Alignement du bloc des syntaxes Cette option modifie la présentation en console du bloc des syntaxes des fonctions. Valeurs possibles : "" | "l" | "r" (par défaut) "" : aucun alignement : Scilab > Elementary Functions > size .................................... SYNTAXES sz = size(x) [n1, n2] = size(x) [n1, n2, n3, ...] = size(x) n = size(x, sel) "l" : les listes d'arguments de sortie sont justifiées à Gauche (Left). Tous les caractères "=" des expressions "LHS = fun(RHS)" et autre "fun(RHS)" sont alignés entre eux : SYNTAXES sz = size(x) [n1, n2] = size(x) [n1, n2, n3, ...] = size(x) n = size(x, sel) "r" (par défaut) : les listes d'arguments de sortie sont justifiées à Droite (Right). Tous les caractères "=" des expressions "LHS = fun(RHS)" et autre "fun(RHS)" sont alignés entre eux : SYNTAXES sz = size(x) [n1, n2] = size(x) [n1, n2, n3, ...] = size(x) n = size(x, sel)
Affichage des hyperliens Considérons l'hyperlien <a href="http://scilab.org">Scilab website</a>. La cible de l'URL peut être locale ou distante. uman() en propose 3 types d'affichage en mode texte : libélé : seul Scilab website est affiché. Rien n'indique l'existence de l'hyperlien. [libélé] : [Scilab website] est affiché. La présence de l'hyperlien est indiquée, mais l'URL de sa cible ne l'est pas. C'est le mode utilisé par défaut à la première installation de uman. libélé [url] : Scilab website [http://scilab.org] est affiché. Lorsque le libélé EST l'URL, [url] = [http://scilab.org] est affiché une seule fois. Les hyperliens ne sont jamais affichés dans les tables des matières, en mode "s" (Sommaires de sous-sections), ni dans la section Voir aussi, excepté lorsque les items sont des références/URL externes.
Voir aussi : liste compacte Sans activer cette option, la liste des items constituant la section Voir aussi est affichée en console à raison d'une ligne par item, avec la description courte de chacun d'eux, comme dans le navigateur d'aide. Exemple : Option désactivée : --> uman xmlGetValues ../.. See Also -------- setPreferencesValue — Set preferences value xmlXPath — Make a XPath query on a XML document XML path language [https://www.w3.org/TR/1999/REC-xpath-19991116/] xmlRead — Read a XML stream from a local or distant file xmlDelete — Delete a XML document atomsGetConfig — Get ATOMS system parameters printsetupbox — Display print dialog box. csvDefault — Get or set defaults behavior for csv files. Option activée (par défaut): See Also -------- setPreferencesValue | xmlXPath | XML path language [https://www.w3.org/TR/1999/REC-xpath-19991116/] | xmlRead | xmlDelete | atomsGetConfig | printsetupbox | csvDefault
Activer le stylage ASCII Lorsque cette option est activée, les parties du texte original qui sont en italique sont affichées en mode texte entre "/.../" : "/Texte en italique/". Celles qui sont en gras sont transcrites tout en majuscules : "TEXTE EN GRAS".. Cette option est déconseillée. En effet, les slashs "/" introduits peuvent potentiellement être pris pour des divisions, lorsqu'une expression comportant des / est mise en italique. De même, un nom de variable mis en gras sera transcrit tout en majuscule, changeant le nom de la variable, puisqu'en langage Scilab les noms de variables sont sensibles aux minuscules/majuscules.
Lister seulement les bugs non résolus Cette option modifie le résultat de uman .. b, lorsque l'information requise concerne les bugs documentés sur Bugzilla. Lorsque l'item relève de Scilab lui-même, la requête est transmise à https://bugzilla.scilab.org. Par défaut, tous les bugs connus concernant l'item sont listés, y compris les bugs indiqués comme résolus. En activant cette option, seuls les bugs dont les rapports sont OPEN ou REOPENED seront listés.
Chemins des modules externes hors ~/contrib vecteur de textes. Chaque élément indique le chemin à un dossier (hors SCI\contrib ni SCIHOME\contrib) que uman doit scruter pour y inventorier des ressources documentaires supplémentaires. Celles-ci doivent être conditionnées en modules selon les règles minimales décrites dans la page dédiée aux aspects techniques internes de uman.

Exemples

Editons le fichier de préférences uman (après avoir utilisé uman ≥ 3.0 au moins une fois) :

scinotes SCIHOME/uman_preferences.xml readonly

Ouvrons l'interface des préférences, à la section de uman :

jdeff org.scilab.modules.preferences.XConfigManager openPreferences prefs; // une fois pour toutes
prefs toolboxes/uman ;

Obtenir la valeur actuelle des paramètres uman, avec une instruction Scilab :

xmlGetValues("//uman",["AlignSyntaxes"  "AllowWideTables" "AsciiStyling" ..
                      "DefaultCallOptions" "ListOnlyUnresolvedBugs" "MaxLinesWidth" ..
                      "PrintHyperlinks" "SeeAlsoOnlyKeywords"]', ..
             "SCIHOME/uman_preferences.xml")

--> xmlGetValues("//uman",["AlignSyntaxes"  "AllowWideTables" "AsciiStyling" ..
  >                       "DefaultCallOptions" "ListOnlyUnresolvedBugs" "MaxLinesWidth" ..
  >                       "PrintHyperlinks" "SeeAlsoOnlyKeywords"]', ..
  >              "SCIHOME/uman_preferences.xml")
 ans  =
!r          !
!unchecked  !
!unchecked  !
!p          !
!unchecked  !
!95.0       !
![content]  !
!checked    !

Voir aussi

uman — Manuel d'utilisation en console, documentation multimodale multilingue avancée
preferences
xmlGetValues

Auteur

Samuel GOUGEON

Historique

Version	Description
3.0	2019-08-22 Interface des Préférences de uman introduite. Les paramètres de configuration spécifiés en Préférences sont maintenant enregistrés dans le fichier `SCIHOME/uman_preferences.xml`. Leur utilisation dans le fichier de démarrage scilab.ini ou .scilab de l'utilisateur est désormais obsolète et ignorée. Nouveaux paramètres : Affichage des hyperliens, Voir aussi : liste compacte, Autoriser les tableaux larges, Lister uniquement les bugs non résolus Création de cette page. La description des paramètres figurant initialement dans la page `uman` principale est transférée ici.
2.1	2016-10-30 : nouveau paramètre Alignement des syntaxes.