نصائح لتحرير وثيقة اللاتكس

Question

الإعداد الافتراضي الخاص بي هو وضع مصدر TEX في مستودع التخريب وإدراج ملاحظات على بعضها البعض كتعليقات في المصدر عند إجراء تغييرات على محتوى الآخرين. كل شيء يشعر أن الأمثل، خاصة عندما يكون هناك صراعات تخريبية حيث يخبرك بكل ما هو "هاتين الإصدارين من هذه الفقرة الضخمة في صراع".

لقد جاءت مع بعض الحيل، لكنني متأكد من وجود أفكار أفضل بكثير (أو أفضل إصدارات من أفكاري) هناك.

للتعاون في التعليمات البرمجية، راجع هذا السؤال:

كيف تتعاون مع المبرمجين الآخرين في الوقت الحقيقي؟

(سوف تنطبق بعض هذه الإجابات على التعاون على وثائق اللاتكس أيضا.)

Answer 1

دائما نهاية كل جملة مع نيولين. أبدا فقرات مصلحة. هذه القواعد لا تقلل فقط من النزاعات الزائفة ولكنها أيضا تجعل ورقتك التي تم تحريرها بشكل تعاوني أسهل في مراجعة.

للتعليق المؤلف، استخدم تعليقات هامشية:

\long\def\authornote#1{%
        \leavevmode\unskip\raisebox{-3.5pt}{\rlap{$\scriptstyle\diamond$}}%
        \marginpar{\raggedright\hbadness=10000
        \def\baselinestretch{0.8}\tiny
        \it #1\par}}
\newcommand{\simon}[1]{\authornote{SLPJ: #1}}
\newcommand{\norman}[1]{\authornote{NR: #1}}
\newcommand{\john}[1]{\authornote{JD: #1}}

نضع هذه في الهامش لأنه كثيرا ما نقم بإعداد ورقة إلى حدود بطول صارمة، ونريد أن تلاحظ الهامشية عدم تغيير طول الورقة. ثم يتم إيقاف الملاحظات الهامشية

\long\def\authornote#1{\relax}

اخترعت أيضا nbibtex أداة (الآن في Debian!) بحيث يمكنك استخدام ملفات .Bib مختلفة من CoAuthors دون الحاجة إلى الاتفاق على مفاتيح Bibtex التعسفي. nbibtex يعمل مثل Bibtex إلا أنه يستخدم الكلمات الرئيسية من المؤلف والعنوان وغيرها من المجالات. يمكن أن يكون ملف Bibtex للمؤلف مختلفا، ولكن إذا كانت الورقة موجودة، nbibtex سوف تجد ذلك.

Answer 2

لتخفيف مشكلة تعارضات التخريب غير المفيدة، يمكنك اعتماد اتفاقية خطوط نيو في نهاية الجمل. (هذا يسهل أيضا إعادة ترتيب أو التعليق أو التعليق على, ، جمل.)

بالنسبة للتعليقات على بعضها البعض في مصدر النص، أجد أنه من الأفضل أن تجعل تلك التي تظهر في وثيقة PDF ولكن لديها القدرة على إيقاف تشغيلها للإصدار النهائي. يمكنني استخدام ماكرو "kibitz"لذلك. لاستخدامه، ضع ما يلي في الجزء العلوي من المستند:

\newcount\Comments  % 0 suppresses notes to selves in text
\Comments=1   % TODO: set to 0 for final version

\documentclass{article}   % or whatever your documentclass

% for comments
\usepackage{color}
\definecolor{darkgreen}{rgb}{0,0.5,0}
\definecolor{purple}{rgb}{1,0,1}
% \kibitz{color}{comment} inserts a colored comment in the text
\newcommand{\kibitz}[2]{\ifnum\Comments=1\textcolor{#1}{#2}\fi}
% add yourself here:
\newcommand{\alice}[1]{\kibitz{red}      {[ALC: #1]}}
\newcommand{\bob}[1]  {\kibitz{purple}   {[BOB: #1]}}
\newcommand{\carol}[1]{\kibitz{cyan}     {[CAR: #1]}}
\newcommand{\deb}[1]  {\kibitz{darkgreen}{[DEB: #1]}}
\newcommand{\evan}[1] {\kibitz{blue}     {[EVN: #1]}}

ثم أليس، على سبيل المثال، يمكن أن تلتصص شيء مثل \alice{Bob must've added the previous sentence which is obviously false.} وسوف تظهر باللون الأحمر في PDF طالما Comments تم تعيين إلى 1.