Settings Help
CTAN
Comprehensive TeX Archive Network
Home Upload Browse

Upload to the Comprehensive TeX Archive Network

Hey, got something new for CTAN? Great! This page allows you to upload it.

Submission

Ready? Then fill in the fields below and upload.

  1. Please add a few bits of information that will help us to categorize it. The required fields are: your name, your email, and a summary (which is typically just a few words, or at most a sentence).

    • In addition, your suggesting a CTAN directory is a help (if you are not sure, just leave it blank). And, a one or two paragraph description will, besides being in the announcement made when the package is installed, be the basis for what might go into the Catalogue. You can help to bring your work to the largest audience by making sure that this description is clear to a non-expert and that it includes words that a person might use in a Catalogue search.
    • About the announcements: we have a mailing list for people who are interested in hearing about changes in our holdings. New packages are always announced on this list. For a revision of an existing package, please note that we don't mail the list about revisions that are bug fixes, minor feature additions, etc. If you make a major upgrade and would like an announcement then tell us so, and include a description of the improvements.
    CTAN Upload Info
    Name of your contribution*
    This value corresponds to the name of the package in the TeX Catalogue.
    Version number*
    Specify a meaningful version number or release date.
    Your name*
    This name will be published with the package.
    Your email*
    This email address will not be published. It is meant for contacting you in case of questions.
    Summary description*
    A short one line summary of what the package does.
    Suggested CTAN directory
    You can browse here. If you start the upload from a package directory then the form is filled with the information known. In doubt leave it empty.
    Type of Upload* New package
    Update (with announcement)
    Update (without announcement)
    Changes*
    (for announcement)

    This text is published if an announcement is requested.
    Administrative notes
    (to the CTAN maintainers)

    This text is for internal communication only. It will not be visible publicly.
  2. Indicate the license. We need to know the license under which you are sharing your work. For more information about the different kinds, see the Catalogue License Definitions. If you don't know what to pick, you might note that the LaTeX Project Public License was developed to suit this purpose.

    Please also indicate the license within the package itself, at least in the top-level README.

    License Info
    License type*
  3. Input your file's name on your computer. It will be uploaded when you submit this form in the final step.

    Note that some file names are blocked, like those ending in .exe, .php, .asp, .cgi. We would prefer a single zip archive. Please do not use any special or non-printable characters (like blank spaces) in file names.

    Upload File
  4. Thanks for providing the information – and thanks for your contribution. You keep TeX going!

    Submit

Preparation

To get ready for uploading please read the points below. You may also find helpful the information at http://tug.org/texlive/pkgcontrib.html.

  • If you have more than one file then please package your contribution as a ZIP archive or a gzip-ed tar archive.

    The CTAN team has decided that packages on the archive shall remain in a browsing-friendly layout, i.e. the best format is to have all the files inside a directory, as illustrated here.

        xxxx.zip:
          xxx/
              README
              xxx.dtx
              xxx.ins
              xxx.pdf
  • Very large packages (such as modern font distributions) are improved by a single extra layer of directory:

        yyy.zip:
          yyy/
            README
            doc/
              yyy-doc.tex
              yyy-doc.pdf
            tex/
              use-yyy.sty
              t1yyy.fd
              ...
            source/
              yyy.sfd
              yyy-Italic.sfd
              ...
            ...

    and so on.

  • In parallel to the main directory tree, CTAN offers the install/ subtree for TDS-structured ZIP files. Such a file will only be accepted as an addition to your upload, not as a replacement. If you want to include such a file in your upload, please check the a href="/TDS-guidelines">TDS guidelines. Call this file xxx.tds.zip and include it at the toplevel of your upload (alongside the xxx directory).

  • Even if what you are sending is a revision of an existing package, please send all of the files, changed or not. We have tools to handle whole uploads so this leads to the fewest errors on our part.

  • We hold thousands of packages, and many thousand files. Our visitors will be helped, and your work will get the recognition that it deserves, only if people can find your package.

    • Include in your upload a plain text file with information that would be useful to a CTAN visitor considering using your package. This information includes a brief description and license information, as well as whether your material requires special fonts or only runs on one kind of platform. Name this file README because then it will show up at most sites when that user is browsing your directory.

      Include in the README file a statement giving your choice of license. That way people who are browsing can see whether your material is available to them (e.g., if your license choice excludes commercial use). Something like: This material is subject to the LaTeX Project Public License.

    • Almost all packages should have documentation beyond the README. It should be in PDF format, since this is what our web visitors can read; in particular, Postscript and DVI formats are not acceptable. Include its source in your upload since free distributions such as TeX Live cannot use the document without source. (For many LaTeX package authors, producing the documentation is a matter of running your .dtx file through pdfLaTeX: pdflatex <docname>.dtx.)

Contact

In case that you need to reach the CTAN team, send an email message to

ctan at ctan.org

(Sorry for not providing a link, but we prefer to not extend this invitation to spammers.)

Guest Book Sitemap Contact 2013-06-18 09:30 CEST