The CDR Manual
The CDR Process
- Submit your document. It should be in a widely used format, like PostScript, PDF, etc. We will check the printability of your document with common current readers. If we cannot print the document, we will ask you to resubmit.
- Also submit accompanying material, if appropriate, like discussion archives, source code of reference implementations, and so on. We will perform basic checks, like whether the accompanying material can be printed with common current readers or whether archives can be unpacked with common current utilities, and so on. However, we will not perform more advanced checks, like whether reference implementations are correct or executable.
- Convince us that we have the right to make the document and the accompanying material publicly available. The easiest is if you are the author and give us the (non-exclusive) publishing rights, or if the document has a free license for documents, like the GNU Free Documentation License or a Creative Commons license, or something similar. Any accompanying material must also have appropriate licenses. Especially, choose an appropriate license for source code, if you provide any. (The licenses should, however, not affect any other material at the CDR website.) We do not want to exclude the possibility of publishing the CDR repository in other forms, like on CD-ROMs or DVDs, etc. So make sure that the publishing rights are not restricted to the CDR website.
- We will make the document and any accompanying material available at the CDR website, under a fresh CDR number that has not been used for any other CDR document before. There will be an initial period of six weeks in which you can send us updated versions, for example to correct typos, etc., which will replace any older version with the same CDR number. You can negotiate with us a longer initial period, but the maximum length is one year. After the initial period, we will freeze the last version of the document and any accompanying material, move it into final status and provide this version from then on as part of the CDR repository, unless you decide that you withdraw the document, in which case we will only provide the title of the document and indicate its withdrawn status for the records.
We reserve the right to reject documents when they are not clearly related to Common Lisp, or contain objectionable material, including in its accompanying material. We also reserve the right to withdraw documents and their accompanying material from the repository in case there are doubts with regard to copyrights. Our priority here is to avoid legal issues that have any negative impact on us as publishers.
You are encouraged, but not required to:
- Discuss your document publicly before you submit it as a CDR document, for example in mailing lists, newsgroups, or other public forums.
- Provide the document in alternative formats, like HTML and plain text. Some people prefer to read HTML or plain text, and these formats may also be more accessible to blind and visually impaired users.
- Provide an archive of the discussions that influenced the contents of the CDR document that we can publish as accompanying material alongside the document itself.
- Provide an abstract of the document that we can use on the website so that readers get a better idea what to expect from the document.
- Provide a rationale as part of the document why it is related to, and/or important for, Common Lisp.
- Use an established structure for the contents of a document, like for example the structure used for issues that accompany the ANSI Common Lisp specification.
- Provide the sources for the document, in case it is generated using, for example, a document preparation system like LaTeX.
- Provide contact email address(es) and/or website URL(s) for further information about the specific document. Email addresses and website URLs can always be updated, including for CDR documents in final status.
How do I submit a document?
Send it to firstname.lastname@example.org. There can be a delay before we react to a submission, but typically we should react promptly. If you don't hear from us within 7 days, bug us. Our first reaction will contain:
- An assessment whether we accept the document for publication or not.
In case we accept the document, our reaction will also contain:
- A fresh CDR number that can be used to refer to the submitted document.
- A URL where the document is published.
- A deadline when the initial period for this document ends (usually after 6 weeks).
We will also announce the submission of the new document, for example in mailing lists, newsgroups and/or in other appropriate ways.
How do I refer to a document?
A CDR document has a unique number. You can refer to it by mentioning that number. Assuming the number of a CDR document is 42, ways to refer to that document include, but are not limited to, CDR document 42, CDR 42 and document 42 in the Common Lisp Document Repository. A URL of the form http://cdr.eurolisp.org/document/NNN" (for example http://cdr.eurolisp.org/document/42 for document 42) can be used to refer to the document as well.
How do I change a document?
During the initial period (usually 6 weeks) after a document has been submitted for the first time, the document and its accompanying material can be resubmitted in a changed form any time by sending it to email@example.com. Afterwards, a document cannot be changed anymore. Under exceptional circumstances, prolongation of the initial period can be negotiated. When you resubmit a document, please consider providing an additional file describing the changes that you have made and their rationales. Depending on the type of change, we will also provide archives of the previous version(s) of the document and the accompanying material for the purpose of documenting the progress, unless you explicitly ask us not to do so.
How do I remove a document?
During the initial period (usually 6 weeks) after a document has been submitted, the document can be removed by the authors at any time by sending a request to firstname.lastname@example.org. Afterwards, a document can only be removed under exceptional circumstances. When a document is removed the repository will show the title of the document and indicate its withdrawn status for the records. We will also provide archives of the version(s) of the document and the accompanying material for the purpose of documenting the progress, unless you explicitly ask us not to do so.
Editorial Note: This text is based on the revision of the Common Lisp Document Repository described in CDR 4.
CDR - Common Lisp Document Repository
The CDR Editors
This page last modified: December 24, 2007