الخوارزميات وقوائم الشيفرة المصدرية
مخطط خوارزمي بـ algorithm2e وقوائم listings للشيفرة الحقيقية.
الخوارزميات وقوائم الشيفرة المصدرية
تعرض الأوراق البحثية الشيفرة بصورتين مختلفتين، ولدى LaTeX أداة مستقلة لكل منهما. الشيفرة الزائفة (pseudocode) مخطط مثالي لخوارزمية، يُنضَّد بكلمات مفتاحية ورياضيات، وتتولاه الحزمة algorithm2e. أما قوائم الشيفرة المصدرية فهي شيفرة حقيقية تُعاد كما هي بخط أحادي المسافة، وتتولاها الحزمة listings. واختيار الأداة الخاطئة هو المصدر المعتاد للمتاعب، لذا من المفيد رؤية الاثنتين.
الشيفرة الزائفة مع algorithm2e
\usepackage[ruled,vlined]{algorithm2e}\begin{algorithm}\caption{Train}\While{not converged}{ Update $\theta$\;}\end{algorithm}تحدد خيارات الحزمة النمط المرئي: يرسم الخيار ruled خطوطًا أفقية أعلى الخوارزمية وأسفلها ويضع العنوان التوضيحي في الأعلى، وهو العرف الذي تتوقعه معظم المؤتمرات والمجلات، بينما يرسم الخيار vlined خطًا رأسيًا صغيرًا يبيّن امتداد كل كتلة، فيبقى التداخل مقروءًا دون إزاحة كبيرة. وبيئة algorithm عنصر عائم مثل الشكل، لذا تحمل الأمر \caption الذي يمنحها رقمًا يمكن للأمر \ref الإحالة إليه.
في الداخل، يُنضِّد \While{condition}{body} الحلقة بكلمة مفتاحية غامقة ثم الشرط ثم الجسم ككتلة مزاحة. وتتبع \For و\If و\Return النمط نفسه. وتنتهي العبارات بـ \; الذي يطبع نهاية السطر ويبدأ سطرًا جديدًا. ونسيانه هو الخطأ الكلاسيكي للمبتدئين: تلتصق الأسطر ببعضها. ولأن هذا LaTeX عادي، فإن الرياضيات مثل $\theta$ تعمل ضمن السطر، وهذا هو الغرض من الشيفرة الزائفة: وصف قاعدة التحديث بالترميز الرياضي لا بلغة برمجة بعينها.
الشيفرة الحقيقية مع listings
\usepackage{listings}\begin{lstlisting}[language=Python]def f(x): return x**2\end{lstlisting}تعيد البيئة lstlisting محتواها كما هو تمامًا، فتحافظ على المسافات البيضاء وتعامل الرموز الخاصة معاملة حرفية، فيمكنك لصق الشيفرة دون تهريب أي شيء. ويفعّل الخيار language=Python إبراز الكلمات المفتاحية لتلك اللغة، وتعرف listings عشرات اللغات الأخرى. الإخراج افتراضيًا عادي. ويضيف معظم الناس مرة واحدة في الديباجة السطر \lstset{basicstyle=\ttfamily\small, numbers=left} للحصول على خط أحادي المسافة بحجم معقول مع أرقام الأسطر. ولتضمين ملف مباشرةً بدل لصقه، يقرؤه الأمر \lstinputlisting[language=Python]{train.py} من القرص، فتبقى الورقة متزامنة مع الشيفرة الفعلية. وإذا أردت إبرازًا ملونًا عالي الدقة، فالحزمة minted بديل أقوى، على حساب الحاجة إلى أداة خارجية وتفعيل shell escape.
الاختيار بينهما
استخدم الشيفرة الزائفة في متن الورقة لإيصال الفكرة، وخصّص القوائم الحرفية للمواد التي تهمّ فيها الشيفرة الدقيقة، مثل الملاحق أو أوصاف الأدوات. ومن الأخطاء الشائعة وضع lstlisting داخل إطار Beamer دون الخيار [fragile]، وهذا يفشل برسالة خطأ غامضة؛ ويظهر التحذير نفسه في أول عرض Beamer.