Difference between revisions of "IRIDIA Technical reports"

From IridiaWiki
Jump to navigationJump to search
(fix bibtex formatting)
(update)
Line 4: Line 4:
   
   
== What is a suitable technical report ==
+
== What is a suitable technical report? ==
   
 
You should consider registering as a technical report any scientific
 
You should consider registering as a technical report any scientific
Line 42: Line 42:
 
submitted and/or published can be registered as technical reports.
 
submitted and/or published can be registered as technical reports.
   
You should consider a report registered in the IRIDIA -- Technical
+
You should consider a report registered in the [http://iridia.ulb.ac.be/IridiaTrSeries IRIDIA -- Technical Report Series] as a publication in itself.
Report Series as a publication in itself.
 
   
== How to cite a IRIDIA technical report? ==
+
== How to cite an IRIDIA technical report? ==
   
 
Here's an example:
 
Here's an example:
Line 61: Line 60:
 
</pre>
 
</pre>
   
== How to register a technical report ==
+
== How to register a technical report? ==
   
 
If you have a scientific or technical document that you think fits
 
If you have a scientific or technical document that you think fits
into the description given in the above section "What is a suitable
+
into the description given in the above section [[#What is a suitable technical report?]], you might consider registering it in the IRIDIA --
technical report", you might consider registering it in the IRIDIA --
 
 
Technical Report Series. This is the procedure you should follow:
 
Technical Report Series. This is the procedure you should follow:
   
Line 73: Line 71:
 
Ph.D. student, check with your supervisor.</li>
 
Ph.D. student, check with your supervisor.</li>
   
<li> Typeset the document using the LaTeX
+
<li> Typeset the document using the [[#Where to find the LaTeX IridiaTrCover package? | LaTeX IridiaTrCover package]].</li>
[[Media:IridiaTrCover-1.6-003.tgz |IridiaTrCover]] package.</li>
 
   
 
<li> Give Muriel the title of the document and the list of the
 
<li> Give Muriel the title of the document and the list of the
Line 83: Line 80:
   
 
<li> Include number and date in your document. See the documentation
 
<li> Include number and date in your document. See the documentation
of the [[Media:IridiaTrCover-1.6-003.tgz |IridiaTrCover]] package
+
of the [[#Where to find the LaTeX IridiaTrCover package? | LaTeX IridiaTrCover package]]
 
to learn how to do this.</li>
 
to learn how to do this.</li>
   
Line 92: Line 89:
   
 
Muriel will then announce the new technical report on the internal
 
Muriel will then announce the new technical report on the internal
mailing list of iridia, and the report will be published on the web.
+
mailing list of IRIDIA, and the report will be published on the web.
   
 
IMPORTANT: Steps 3 and 5 should be performed with no delay in between!
 
IMPORTANT: Steps 3 and 5 should be performed with no delay in between!
Line 105: Line 102:
 
</ul>
 
</ul>
   
== How to submit a revised version of a technical report ==
+
== How to submit a revised version of a technical report? ==
   
 
Whenever you feel like submitting a revised version of a technical
 
Whenever you feel like submitting a revised version of a technical
Line 114: Line 111:
   
 
A revised version must contain a "revision history" on the copyright
 
A revised version must contain a "revision history" on the copyright
page. Please read on to understand what a revision history is. You
+
page. Please read [[#Numbering of the IRIDIA -- Technical Report Series]] to understand what a revision history is. You
should also have a look at the documentation of the IridiaTrCover.sty
+
should also have a look at the documentation of the [[#Where to find the LaTeX IridiaTrCover package? | LaTeX IridiaTrCover package]].
LaTeX package.
 
   
== Understanding the numbering of the IRIDIA -- Technical Report Series ==
+
== Numbering of the IRIDIA -- Technical Report Series ==
   
 
The number of a technical report is composed by the string
 
The number of a technical report is composed by the string
Line 129: Line 125:
 
together with the date.
 
together with the date.
   
A technical report might be "revised". The first version of a
+
A technical report might be ''revised''. The first version of a
 
technical report is revision number 001. Revision numbers are made of
 
technical report is revision number 001. Revision numbers are made of
 
3 digits, possibly left-padded with zeros.
 
3 digits, possibly left-padded with zeros.
Line 161: Line 157:
 
please submit a new technical report.
 
please submit a new technical report.
   
  +
<!-- This is a bit confusing and unnecessary for most of the people. I leave it here just for the sake of completeness.
 
Please notice that the numbering conventions adopted for the IRIDIA --
 
Please notice that the numbering conventions adopted for the IRIDIA --
 
Technical Report Series let us register 999 revisions of the same
 
Technical Report Series let us register 999 revisions of the same
Line 171: Line 168:
 
conventions to be adopted starting from Jan 1, 10000 should be a
 
conventions to be adopted starting from Jan 1, 10000 should be a
 
priority, at least for the next couple of months. :)
 
priority, at least for the next couple of months. :)
  +
-->
   
 
== File name conventions ==
 
== Understanding the file name conventions ==
 
   
 
The PDF file of a technical report should have a name that matches the
 
The PDF file of a technical report should have a name that matches the
 
following pattern: IridiaTrXXXX-YYYrZZZ.pdf where XXXX is the year,
 
following pattern: IridiaTrXXXX-YYYrZZZ.pdf where XXXX is the year,
 
YYY is the number, and ZZZ is the revision. Remember zero-padding
 
YYY is the number, and ZZZ is the revision. Remember zero-padding
  +
number and revision! The original version is the very first revision and, hence, it contains the revision number 001 in its name.
number and revision!
 
   
 
If you submit a technical report (very first version)
Also the very first revision---i.e., the text originally
 
submitted---should contain the revision number 001 in its name.
 
 
Let me repeat: If you submit a technical report (very first version)
 
 
and Muriel gave you number TR/IRIDIA/XXXX-YYY, you should send to the
 
and Muriel gave you number TR/IRIDIA/XXXX-YYY, you should send to the
 
email address [mailto:techrep@iridia.ulb.ac.be <techrep@iridia.ulb.ac.be>]
 
email address [mailto:techrep@iridia.ulb.ac.be <techrep@iridia.ulb.ac.be>]
Line 190: Line 184:
 
IridiaTrXXXX-YYYr002.pdf and so on.
 
IridiaTrXXXX-YYYr002.pdf and so on.
   
== Where to find the LaTeX IridiaTrCover package ==
+
== Where to find the LaTeX IridiaTrCover package? ==
   
The most recent version of the LaTeX IridiaTrCover package is available
+
The most recent version of the LaTeX IridiaTrCover package is [[Media:IridiaTrCover-2.0-r11.tar.gz|IridiaTrCover-2.0-r11.tar.gz]]
[[Media:IridiaTrCover-1.6-003.tgz |here!]]
 
   
   
== How to use the IridiaTrCover.sty for LaTeX ==
+
== How to use the IridiaTrCover.sty for LaTeX? ==
   
 
Read the technical report [http://iridia.ulb.ac.be/IridiaTrSeries/IridiaTr2005-006r006.pdf TR/IRIDIA/2005-006]
Just read the documentation that comes with the IridiaTrCover package.
 
The package contains the source file of the technical report
 
[http://iridia.ulb.ac.be/IridiaTrSeries/IridiaTr2005-006r003.pdf TR/IRIDIA/2005-006].
 
By the way, the title of that technical report is:
 
 
 
<pre>
 
<pre>
 
The IridiaTrCover package for LaTeX:
 
The IridiaTrCover package for LaTeX:
Line 208: Line 197:
 
</pre>
 
</pre>
   
  +
The [[#Where to find the LaTeX IridiaTrCover package?|IridiaTrCover package]] contains also the technical report and its source file.
It could be a useful reading if you plan to submit a technical report
 
at IRIDIA. :)
 
   
  +
== What if you are not able to use LaTeX ==
+
== What if you are not able to use LaTeX? ==
   
 
If you are not able to use LaTeX, you can produce your technical
 
If you are not able to use LaTeX, you can produce your technical
report in pdf format and ask then
+
report in PDF format and ask then
 
[mailto:ericyuanzhi@gmail.com Eric] or [mailto:Sabrina.Oliveira@ulb.ac.be Sabrina]
 
[mailto:ericyuanzhi@gmail.com Eric] or [mailto:Sabrina.Oliveira@ulb.ac.be Sabrina]
to generate a cover page and to preappend it to your file.
+
to generate a cover page and to prefix it to your file. Apart from this step, please follow the [[#How to register a technical report?|other steps described above for registering your technical report]].
 
Apart from this element, please follow the other steps described above
 
for registering your technical report.
 
 
 
 
--[[User:Mbiro|Mbiro]] 14:41, 10 January 2006 (CET)
 

Revision as of 13:30, 16 March 2010

The IRIDIA -- Technical Report Series is a series of reports published on the web by IRIDIA. The series is officially registered and has an ISSN number: 1781-3794.


What is a suitable technical report?

You should consider registering as a technical report any scientific or technical document that you wish to share with other researchers at IRIDIA or elsewhere. Good examples are:

  1. a scientific paper that you have submitted for publication in a journal or in the proceedings of a conference (IRIDIA researchers are STRONGLY invited to submit as technical report, at the time of submission, all conference or journal papers they write).
  2. a scientific work that you have published somewhere. Please notice that there might be some copyright issues!!! In any case, you should be aware that the copyright notice of the technical report goes like this:
              The authors take full responsibility for any copyright
     	  breaches that may result from publication of this paper in
     	  the IRIDIA -- Technical Report Series.  IRIDIA is not
     	  responsible for any use that might be made of data appearing
     	  in this publication.
    
  3. the dirty details of an algorithm that no scientific journal would ever wish to publish.
  4. the whole set of results of an experimental analysis with all plots and all tables.
  5. the manual of a computer program that you have written.

Note that not only the works that are submitted and/or published can be registered as technical reports.

You should consider a report registered in the IRIDIA -- Technical Report Series as a publication in itself.

How to cite an IRIDIA technical report?

Here's an example:

  @TechReport{BirLopBru2005:IridiaTrCover
    author =      {M. Birattari and M. L{\'o}pez-Ib{\'a}{\~n}ez and A. Brutschy }
    title =       "The {IridiaTrCover} package for \LaTeX:
                   How to typeset documents for the 
                   IRIDIA -- Technical Report Series",
    institution = {IRIDIA, Universit\'e Libre de Bruxelles},
    year =        2005,
    number =      {TR/IRIDIA/2005-006},
    address =     {Brussels, Belgium},
  }

How to register a technical report?

If you have a scientific or technical document that you think fits into the description given in the above section #What is a suitable technical report?, you might consider registering it in the IRIDIA -- Technical Report Series. This is the procedure you should follow:

  1. Double check that your document is indeed suitable for being registered in the IRIDIA -- Technical Report Series! If you are a Ph.D. student, check with your supervisor.
  2. Typeset the document using the LaTeX IridiaTrCover package.
  3. Give Muriel the title of the document and the list of the authors. She will give you a technical report number and a date. The date will be something like "MONTH YEAR" where MONTH and YEAR are respectively the month and the year in which the technical report number is assigned to your document.
  4. Include number and date in your document. See the documentation of the LaTeX IridiaTrCover package to learn how to do this.
  5. Give Muriel a printed copy of the technical report and send the PDF file to the email address <techrep@iridia.ulb.ac.be>.

Muriel will then announce the new technical report on the internal mailing list of IRIDIA, and the report will be published on the web.

IMPORTANT: Steps 3 and 5 should be performed with no delay in between!

  • DO NOT ask for a technical report date and number unless the document you want to register is already written, well formatted and ready to be distributed.
  • DO NOT ask to register your technical report with a date that is not the one in which you indeed register it.

How to submit a revised version of a technical report?

Whenever you feel like submitting a revised version of a technical report of yours, just give a printed copy of the new version to Muriel and send the PDF file to the email address <techrep@iridia.ulb.ac.be>. The new revision will be published on the web.

A revised version must contain a "revision history" on the copyright page. Please read #Numbering of the IRIDIA -- Technical Report Series to understand what a revision history is. You should also have a look at the documentation of the LaTeX IridiaTrCover package.

Numbering of the IRIDIA -- Technical Report Series

The number of a technical report is composed by the string "TR/IRIDIA/" followed by the year (4 digits), a hyphen and then a progressive number (3 digits, possibly left-padded with zeros). The first technical report of year XXXX gets the number TR/IRIDIA/XXXX-001, the second TR/IRIDIA/XXXX-002, and so on.

This is the number that appears on the cover of a technical report together with the date.

A technical report might be revised. The first version of a technical report is revision number 001. Revision numbers are made of 3 digits, possibly left-padded with zeros.

If you wish to refer to revision ZZZ of technical report YYY registered in year XXXX, the number you should use is "TR/IRIDIA/XXXX-YYY.ZZZ". Remember the zero-padding!!!

In general, TR/IRIDIA/XXXX-YYY refers to the most recent revision available. When you cite a technical report, do not include the revision number. The revision number should be included only if you wish to refer to a specific revision or if you wish to point out differences between revisions---e.g., "revision TR/IRIDIA/XXXX-YYY.002 contained a stupid mistake that has been corrected in following revisions".

In any case, the cover does not report the revision number, and the date is always the one of the first revision, i.e., the version originally submitted.

The revision history appears on the copyright page. A technical report that is a revision of a previously submitted one must always feature the revision history on the copyright page.

A technical report is uniquely identified by its number. So a new revision can have a different title and also different authors---e.g., different order, one author added, one removed, etc.

Anyway, if the title and/or the author list changes and/or if the technical report undergoes really MAJOR-MAJOR-MAJOR modifications, please submit a new technical report.


File name conventions

The PDF file of a technical report should have a name that matches the following pattern: IridiaTrXXXX-YYYrZZZ.pdf where XXXX is the year, YYY is the number, and ZZZ is the revision. Remember zero-padding number and revision! The original version is the very first revision and, hence, it contains the revision number 001 in its name.

If you submit a technical report (very first version) and Muriel gave you number TR/IRIDIA/XXXX-YYY, you should send to the email address <techrep@iridia.ulb.ac.be> a PDF file called IridiaTrXXXX-YYYr001.pdf (include the revision number!). If you revise the report, the PDF of the revised version will be called IridiaTrXXXX-YYYr002.pdf and so on.

Where to find the LaTeX IridiaTrCover package?

The most recent version of the LaTeX IridiaTrCover package is IridiaTrCover-2.0-r11.tar.gz


How to use the IridiaTrCover.sty for LaTeX?

Read the technical report TR/IRIDIA/2005-006

  The IridiaTrCover package for LaTeX: 
  How to typeset documents for the IRIDIA -- Technical Report Series

The IridiaTrCover package contains also the technical report and its source file.


What if you are not able to use LaTeX?

If you are not able to use LaTeX, you can produce your technical report in PDF format and ask then Eric or Sabrina to generate a cover page and to prefix it to your file. Apart from this step, please follow the other steps described above for registering your technical report.