Unmodified copy from www.astro.uu.nl 13.July 2010

Article Preparation Guidelines

This document guides Living Reviews authors when preparing their articles. It includes the Living Reviews LaTeX Template. You can download the template in pdf format, as well as its original LaTeX source, which you can use as a template for your own article. The following four sections cover:

I. The Living Reviews Style Files, which describes the style files provided by Living Reviews to help authors prepare their review article.

II. The Living Reviews LaTeX Template. The automated conversion and processing of the review articles by the Living Reviews software requires an unambiguous and often restricted LaTeX code. This template shows how to structure your LaTeX source, what LaTeX commands and environments to use and which to avoid.

III. Keywords, which explains how and why we ask authors to keyword their article and all their citations.

IV. Citations, which explains about the way documents, and in particular electronic resources, should be cited within a Living Reviews article. The Living Reviews citation style is explained in detail in our Citation Guidelines. backTo Author Main Page I. The Living Reviews Style Files

Article Style (epubtk.sty, click for download) Authors should compose their reviews in LaTeX, incorporating the style file provided by Living Reviews, epubtk.sty. This file provides commands allowing us to process articles more easily for Living Reviews.

Bibliography Style (LivRevSolar?.bst, click for download) For the bibliography of review articles, we provide authors with our BibTeX style file, LivRevSolar?.bst. If possible, please submit your reference list as a BibTeX database rather than standard LaTeX \bibitem lists, because references in BibTeX format allow a smooth and automated extraction of the bibliographic information into the searchable journal wide reference database, which is a key part of Living Reviews. The file LivRevSolar?.bst is built on the BibTeX style file plainnat.bst provided by the natbib package. We have only added several features to accommodate electronic resources. The document Using BibTeX to help create your Living Reviews Article explains these additional features. Top of this Document II. Living Reviews LaTeX Template

For publication on the web, your review article will pass through an automated conversion, first from LaTeX to HTML, and then, in a second step, to its final Living Reviews specific online form. The conversion scripts require a clear, unambiguous and sometimes restricted LaTeX source. Therefore we would like to ask authors to consult the Living Reviews LaTeX template, when creating the LaTeX source for their article. It describes the article skeleton, i.e. the essential parts each review article should contain, gives working examples for more complicated or ambiguous equation environments. Please read this document carefully, when preparing the LaTeX source of your review article.

The LaTeX source of the Living Reviews LaTeX template follows the recommended Living Reviews style. Hence it can be used as a template to start your own article from.

For reading:

  • the document in PDF format.
  • the document in HTML format, where you can see how the included features (pop-up windows, figures, movies) appear in the online version.

For use as a template:

  • the LaTeX sources of the document, LivRevSolarTemplate?.tar.gz.
  • the bibliography associated with the document, as a BibTeX database LivRevSolar?.bib (this is the format we strongly encourage you to use for the bibliography of your article)
  • the Living Reviews style files: LivRevSolar?.bst, epubtk.sty

Top of this Document III. Keywords

Purpose Keywords in Living Reviews will be used to classify both the papers we publish and the references they contain. All articles appearing in Living Reviews, and all references appearing in those articles, are collated into a journal-wide reference database. The search output of this database can be obtained in form of a hypertext document, incorporating, where possible, active links to the materials it indexes. Through this, Living Reviews provides a comprehensive way for its users to become aware of and, where possible, to directly access the most important research in the field, even without going through any specific review article. Because all the citations in Living Reviews have been selected by leading specialists, those using the journal in this way can be assured that the references they find are worth considering. To assist this we ask our authors to provide keywords to classify their article and the references which they cite.

List of Keywords

Our working scheme will be to have a series of keywords that is non-hierarchical (only one level), fairly general (many papers classed under each keyword), and overlapping (each paper will have several keywords). A core list of keywords will be provided soon. Meanwhile check the keywords in our reference database. This list is expected to evolve over time based on author's suggestions.

How to Specify Keywords In the LaTeX source, keywords for the article itself will be shown under the abstract, and keywords for references will be shown at th end of the bibliography entry for each reference. Authors add keywords to their references by using either the \epubtkKeywords{...} command (defined in epubtk.sty) or the keywords BibTeX field (defined in LivRevSolar?.bst). Those using BibTeX simply add keywords as a field to their BibTeX entries. Those not using BibTeX place the \keywords{...} command after each reference; the argument passed to the \keywords{...} command is a comma separated list of keywords.

For examples see our lists of example citations, both for reference lists in our preferred BibTeX format and also in LaTeX, which are part of the Citation Guidelines. Top of this Document IV. Citations

Citation Style We would like to ask authors to ensure that the list of references they submit with their review article conforms to the journal's citation style which is defined in detail in the Citation Guidelines.

For authors using BibTeX, our selected citation style will be produced by the Living Reviews style file automatically. Authors only need to provide the bibliographic data using the appropriate BibTeX fields. An overview on the required and optional fields for each of the document types defined for Living Reviews in Solar Physics is given in the Table of Document Type Definitions . See also the document Using BibTeX for Your References for details.

Authors who submit their list of references in plain LaTeX instead of BibTeX we would like to ask to follow closely the formatting guidelines for citations. This enables the publishing software to recognize the kind of citation, dissect it into its main elements, and then reassemble them in various formats for the searchable Living Reviews reference database, which we provide to our readers. See the List of Example Citations how to format your references correctly, depending on the type of document you are refering to in your citation.

Annotations of References The reference list of the review article should not contain any comments or annotations. Authors are encouraged to comment on the importance and usefulness of references, but this should be done in the text where the references are cited. Authors should bear in mind that the information in their reference list will be used in the global reference database, and any embedded comments will look out of place there.

Citing Electronic Information Authors should carefully consider the informative value of any hypertext links they wish to make to purely electronic sources like web sites, homepages, etc. Just as an author would only cite print articles that are worth reading, she or he should only point to potentially helpful electronic materials. Aside from such purely electronic resources, whenever an electronic version of printed work that an author is citing is available online, we encourage the author to include also this electronic version in the citation to allow users instant access to the material.

URLs will be made into active links by Living Reviews, as HTML markup will occur during article processing by Living Reviews. Therefore, authors do not need to worry about placing any html in their articles. Care should be taken, however, to cite urls and other online sources completely, following the Living Reviews Citation Guidelines.

In the article text, the author should introduce solely electronic resources with a short phrase or sentence of annotation which explains what can be found at a given url and why a user might go there. Such explanations, even though brief, help journal users to understand the value of the links they're viewing and to judge whether they wish to follow them. This kind of annotation is most easily and naturally done in the "Going Further" section, mentioned above, but it could also appear in the body of the text.