3 votes

Quel est le bon style pour documenter les touches de raccourci OS X sur le web avec markdown ?

Je dois souvent donner des instructions sur l'utilisation des touches de raccourci d'OS X dans la documentation. Je les écris en markdown, généralement sur des pages GitHub et parfois sur StackExchange. Les touches sont formatées avec key = key .

Dans les interfaces OS X, les touches sont généralement listées ensemble, sans espace entre elles. Mais OS X utilise une police bien lisible, donc la chaîne de caractères est jolie.

enter image description here

Mais lorsqu'ils sont rendus sur un site web, les symboles n'ont pas toujours un bel aspect. Il y a donc deux options : soit écrire toutes les clés dans une seule balise, soit chacune dans une balise distincte

Option 1.

* \ = `«`
* \ = `»`

Résultant en

  • \ = «
  • \ = »

Option 2

* \ = `«`
* \ = `»`

Résultant en

  • \ = «
  • \ = »

Lequel est le meilleur ? Devrais-je ajouter + des symboles entre les deux ? (Ce qui me semble être un style Windows).

Option 2a

  • + \ = «
  • + + \ = »

5voto

Tetsujin Points 95239

Je ne suis pas sûr que ce soit gravé dans le marbre, mais la convention pour Ask Different semble être du type suivant

Cmd Ctrl Opt Shift T
Cmd Ctrl Opt Shift T

en indiquant le nom abrégé et le symbole de la clé, sans + entre les deux.

Ce n'est pas aussi ordonné que la méthode Apple, il est vrai.

Je ne suis pas certain de l'équivalence des clés, mais peut-être
Opt Shift \ \= »
comme votre option 2.

BTW, j'utilise System Prefs > Keyboard > Text pour générer rapidement ces données dans Stack Exchange.
(qui apparemment ne fonctionne que dans Safari, pas dans Firefox ou Chrome, voir Remplacer le texte par une valeur prédéfinie dans le navigateur )

enter image description here

LesApples.com

LesApples est une communauté de Apple où vous pouvez résoudre vos problèmes et vos doutes. Vous pouvez consulter les questions des autres utilisateurs d'appareils Apple, poser vos propres questions ou résoudre celles des autres.

Powered by:

X