ماكروهات تحافظ على اتساق الترميز

newcommand، وNewDocumentCommand، وملف ماكروهات مشترك.

ماكروهات تحافظ على اتساق الترميز

في كل ورقة بحثية رموز رياضية تتكرر: الأعداد الحقيقية، وعامل التوقع، والقيمة المطلقة بخطوط رأسية بحجم مناسب. فإذا كتبت \mathbb{R} في أربعين موضعًا ثم فضّل مشرفك لاحقًا \mathbf{R}، صار أمامك أربعون تعديلًا، وسيفوتك واحد منها. يحوّل الماكرو هذا الترميز إلى أمر واحد له اسم، يُعرَّف مرة واحدة. غيّر التعريف يتغير المستند كله تبعًا له. وهكذا يبقى الترميز متسقًا: فلا يمكن للمصدر أن يخرج عن التزامن مع نفسه.

تعريف الأوامر باستخدام newcommand

\newcommand{\R}{\mathbb{R}}
\newcommand{\E}[1]{\mathbb{E}\left[#1\right]}
\newcommand{\abs}[1]{\left\lvert #1 \right\rvert}

التعريف الأول هو أبسط الأنواع: صار \R اختصارًا محضًا، وكتابة \R في أي موضع تنتج \mathbb{R}.

أما الصيغة الثانية فتأخذ وسيطًا. يعلن [1] بعد الاسم أن \E يقبل وسيطًا واحدًا، ويحدد #1 الموضع الذي يقع فيه هذا الوسيط في الناتج بعد التوسيع. وهكذا يصبح \E{X} مساويًا لـ \mathbb{E}\left[X\right]. والتعريف يمنحك أكثر من الاختصار: فالزوج \left[ و\right] يجعل الأقواس تتمدد لتلائم ما بداخلها، فتحصل \E{\frac{X}{n}} على أقواس طويلة تلقائيًا. ويفعل الماكرو \abs الشيء نفسه مع \lvert و\rvert، وهما الزوج الصحيح من الخطوط الرأسية للقيمة المطلقة. يمكنك الإعلان عن تسعة وسائط على الأكثر والإشارة إليها بـ #1 حتى #9.

إذا كان الأمر موجودًا مسبقًا، يرفض \newcommand إعادة تعريفه ويتوقف بخطأ، وهذا يحميك من إفساد شيء ما دون أن تنتبه. ولاستبدال أمر موجود عن قصد، استخدم \renewcommand بدلًا من ذلك.

الواجهة الحديثة

تأتي إصدارات LaTeX الحالية أيضًا بأمر تعريف أغنى:

\NewDocumentCommand{\citepair}{mm}{\cite{#1}, \cite{#2}}

يستخدم \NewDocumentCommand سلسلة وصف للوسائط بدلًا من عددها. هنا تعني mm وسيطين إلزاميين، ولذلك يستشهد \citepair{knuth84}{lamport94} بكلا المفتاحين. وتتجاوز لغة الوصف هذه ما يستطيعه \newcommand: فـ o يعلن وسيطًا اختياريًا بين قوسين مربعين، وs يكتشف الصيغة ذات النجمة، وO{default} يعطي الوسيط الاختياري قيمة افتراضية. وفي كل ما يتجاوز الاستبدال البسيط، استعن بهذه الواجهة.

شارك التعريفات

احتفظ بملف macros.sty مشترك بين الفصول. ضع تعريفاتك في هذا الملف الواحد، وحمّله بالأمر \usepackage{macros} من كل مستند، فتتفق على الترميز جميع فصول الأطروحة، ومعها الشرائح ونسخة الورقة البحثية. وعندما ينضم متعاون جديد، يقرأ ملفًا قصيرًا واحدًا ليتعرف على اصطلاحاتك بدلًا من استنتاجها من النص بالهندسة العكسية. وهذا يتكامل بطبيعته مع إعداد المشروع من عدة ملفات.

نصيحة في التسمية: أعطِ الماكروهات أسماء ذات معنى مثل \abs أو \norm بدلًا من أسماء تصف الشكل مثل \bigbars. ينبغي أن يدل الاسم على معنى الترميز، فيبقى التعريف حرًّا في تغيير مظهره. وقاوم إغراء تعريف ماكرو لشيء تستخدمه مرتين فقط؛ فالفائدة تبدأ عند الاستخدام الثالث تقريبًا.

العودة إلى وقت التشغيل