Upload to the Comprehensive TeX Archive Network

You have something new for CTAN? — This page allows you to upload it.

Here are a few points to consider to get ready for uploading.

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

• If you are sending a revision of an existing package, please send all of the files, changed or not. This way is least likely to attract errors on our part.

  If you believe it's really impossible to upload the whole thing, please explain exactly what you have uploaded. Our installation procedure, by default, deletes everything in its path, so we need to know what's to be kept.

• Please include in your archive a plain text file with any special information that you might be useful to a CTAN visitor, such as whether your material requires special fonts, or only runs on one kind of platform. Name that file `README' because then it will show up (at some 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. See www.ctan.org/tex-archive/help/Catalogue/licenses.lppl.html for the details of that license.

• All packages should have a documentation file. We ordinarily expect that this documentation be provided as an Acrobat .pdf file, since it is the format that most of our web visitors can read. Documentation in plain text is just about acceptable, but Postscript and DVI are definitely not acceptable.

  For many LaTeX package authors, producing this documentation is a matter of running the documented source file (.dtx) with pdfLaTeX. Some packages come with separate documentation: that documentation should also be distributed in .pdf form.

1. We need a little information that will help us to categorise your submission. We need at least your name, your email, and a caption (typically a simple phrase or short sentence).

   In addition, we welcome your suggestion of a CTAN directory for us to install the file; if you are not sure, just leave that field blank. Please also provide a short text for us to use in our announcement that the package base been installed, and as the basis for what will go into the Catalogue.

   You can help to bring your work to the largest audience by making sure that this short text is clear to a non-TeXpert and that it includes keywords that a person might use in a search for your file.

   Name of your contribution
   Your name
   Your email
   One-line description
   Version number
   Suggested CTAN directory (you can browse here).
   Short text for announcement:
   No need to announce this update

2. Indicate the licence.

   We need to know the licence under which you are sharing your work. For more information about the different kinds, see the Catalogue Licence Definitions.

   Licence type

   If you selected “Free” you should refine your choice

   • If you don't know what to pick, you might note that the (free) LaTeX Project Public Licence was developed specifically for TeX macro packages.
   • TeX distributions such as TeX-live, MikTeX and teTeX take (almost all) their content from CTAN sources. They will only take material that falls under a “free” licence from the free list above.
   • It is helpful if, in addition to choosing your licence here, you also include a statement of that choice in the material that you upload. (This is essential if you choose "Other-nonfree" or "Other free", since in that case there is no external means of knowing what your licensing restrictions are.) With a separate statement, a person browsing through the archive can easily determine whether your material is available to them (e.g., if your licence choice excludes their use, since they work in a commercial enterprise). If you are uploading just a single text file then you can include a statement of your choice in a comment at the start of that file. If you are uploading a binary file, or multiple files, then you can indicate your choice in a ‘README’ or ‘LICENSE’ file and have it apply to all of your archived work. Something like:

     This material is subject to the LaTeX Project Public Licence. See www.ctan.org/tex-archive/help/Catalogue/licenses.lppl.html for the details of that licence.

3. Select the file on your computer (“Browse” pops up a file selection box, or you may type a path, direct). The file will be uploaded when you submit this form in step (4).

   • If you are uploading more than just a file or two then we will probably put your material in a separate directory. In that case, please think about whether to include a file with any special information that you think might be useful, such as if your material requires special fonts, or only runs on one kind of platform, etc. Many CTAN users find such a file convienent, especially if you name it ‘README’ because then it will show up (at some web sites) when that user is browsing the directory.
   • We prefer that you package your contribution as an archive, especially if you are uploading more than a file or two. Of the available archive types, we have had the best experience with Zip archives and gzipped tar archives. We cannot ordinarily deal with Microsoft CABinet files, or .ZOO or .RAR files.

4. Thanks for providing the information — and thanks for your contribution. Your contributed package will help keep TeX going!

About this page: contact the CTAN team, the Cambridge CTAN home page  Internet connection provided by the University of Cambridge Computer Laboratory

SEARCH:

Related searches:
licence material archive choice please

gipoco.com is neither affiliated with the authors of this page or responsible
for its contents. This is a safe-cache copy of the original web site.

gipoco.com is neither affiliated with the authors of this page nor responsible for its contents. This is a safe-cache copy of the original web site.