Browse Source

Write package documentation

develop
Damien Goutte-Gattat 8 years ago
parent
commit
93ffdf42e4
1 changed files with 52 additions and 4 deletions
  1. +52
    -4
      flygenet.dtx

+ 52
- 4
flygenet.dtx View File

@ -46,7 +46,7 @@ has been generated for details.
\ProvidesFile{flygenet.dtx}[2013/07/14 v0.1 Fly genetics notation]
\documentclass[a4paper]{ltxdoc}
\usepackage{hyperref}
\usepackage{wasysym}
\usepackage{flygenet}
\EnableCrossrefs
\CodelineIndex
\RecordChanges
@ -105,12 +105,60 @@ has been generated for details.
%
% \maketitle
%
% \abstract{The abstract}
%
% \tableofcontents
%
% \section{Introduction}
% The introduction.
%
% Fly geneticists conventionally denote fly genotypes using a math-like
% notation, as in the following example:
%
% $$
% \genotype{C(1)RM,y^2/Y; In(2LR)O, Cy cn^2 sp^2/Sco; ci^D/ey^D}
% $$
%
% Consequently, \LaTeX's math mode (and especially displayed math mode,
% as above) is well suited to typeset such notation.
%
% However, typesetting a genotype can be quite tedious, as it requires
% many calls to the |\frac| macro (or the |\over| primitive) and
% constant use of manual spacing to override \TeX's
% math-mode spacing.
%
% This package is intended to reduce the amount of code needed to
% typeset a genotype. For example, the genotype above is the result of
% the following code:
%
% \begin{verbatim}
% \genotype{C(1)RM,y^2/Y; In(2LR)O,Cy cn^2 sp^2/Sco; ci^D/ey^D}
% \end{verbatim}
%
% A complete genotype can thus be written in a very intuitive way, the
% only \TeX ism being the exponentiation symbol (|^|).
%
%
% \section{User interface}
%
% The main user-level macro is |\genotype|. It accepts a single argument
% which is the genotype to typeset, with semi-colons to separate
% chromosome pairs and slashes to separate the two chromosomes of a
% pair.
%
% The macros |\female|, |\male|, and |\virgin| are used in the same way
% and perform the same task as |\genotype|, but they insert a female
% (\venus), male (\mars), or virgin female (\mercury) symbol in front of
% the genotype:
%
% $$
% \female{cn bw/;TM2/tra}
% \quad
% \virgin{cn bw/;TM2/tra}
% \quad
% \male{FM7a/Y;In(2LR)O,Cy/+}
% $$
%
% The plural forms of these macros (|\females|, |\males|, and
% |\virgins|) are similar but insert \emph{two} symbols, thus denotating
% several individuals of the indicated genotype.
%
%
% ^^A Inserts the LPPL text.


Loading…
Cancel
Save