Instructions for authors







Italian version of the instructions

German version of the instructions

Note: This text was automatically translated from German by DeepL and slightly adapted.

1. Register/log in to WordPress

Go to the KiT website (http://www.kit.gwi.uni-muenchen.de/) and log in there. If you do not already have an account, please click on "Registrieren" (https://www.kit.gwi.uni-muenchen.de/wp-login.php?action=register). Once you have registered, please send an e-mail to KiT_signup@itg.uni-muenchen.de and wait for confirmation that your account has been added to the "Authors" group. Then you can log in with your username and password by clicking on "Anmelden".

2. Create content

2.1. Contributions/Articles

2.1.1. What is the "post/article" content format for?

Description follows...

2.1.2. Creating new posts

  • Go to "Beiträge / Artikel" and click on "Add New".
  • Enter the title of your post in the "Add title" field. The title can be changed at any time. Now you can write your text in the field that appears under the "Post" tab. You can also format the text via the menu bar (font size, numbered bullets/ with bullet points, links, tables, etc.).
  • To enter an abstract, please click on the "Abstract" tab and enter your text there.
  • Select the volume to which your contribution belongs under "Bände" on the right.
  • IMPORTANT: The contribution must be saved before you change/leave the page. To do this, click on "Save" on the right. Post changes will NOT be saved automatically!

2.2. Volumes

2.2.1. What is the "volume" content format for?

Description follows...

2.2.2. Create a new monograph

Description follows...

2.2.3. Create new anthology

Description follows...

3. Creating texts

3.1. General information about the WordPress editor

WordPress uses a visual editor whose operation is similar to that of word processors; the result is HTML-annotated text (see the editor's 'Text' view at top right) that includes formatting information (e.g. p tags around each paragraph).

The mark-up of the text should be purely structural, the presentation is separate from this and takes place in a further step when the HTML text code is transformed on the website (frontend) with style sheets or via a transformation script into TeX format (PDF) and can be adapted at any time. Therefore, for example, no font should be defined, this is done globally for the post via CSS/LateX definition. (The visual editor itself already displays the HTML-annotated text partially formatted with its own stylesheets; however, this does not have to correspond to the formatting in the frontend/view upon publication).

To obtain a correspondingly cleanly annotated HTML code, one should therefore also refrain from copy&paste from Word etc. or first copy the content into a pure text editor and then copy the result into the WordPress editor; otherwise, formatting will be inserted along with it, which one does not necessarily see in the visual editor, but which leads to problems in the further processing of the HTML code.

If no text editor is used as an intermediate step, the function "DELETE FORMATTING" in the editor (under >Format) must be applied to the text marked with Ctrl-A and care must be taken not to insert any superfluous style specifications afterwards either (visible in the 'Text/Html view as "<span style=...").

For distraction-free writing, the full-screen mode under 'View' is recommended.

3.2. Add media (images, audio, video, etc.)

Click the 'Add Media' button above the text entry field and upload the desired file. Images can be added with a caption.

Here you can see the tutorial:

 

 

3.3. Using shortcodes

To call up certain functions (e.g. inserting the bibliographic information for references, see below), a WordPress-specific shortcode syntax is used. Shortcodes have the following schematic structure:

[shortcode attribute=attribute_value]

In KiT, self-defined shortcodes are used for setting references as well as annotations/footnotes.

3.4. References to chapters

In order to refer to a chapter, a label must first be assigned to the chapter. To do this, the shortcode "label" is inserted after the (sub)heading, e.g.

[label key="general"]

The key attribute should only consist of letters and numbers.

Then the ref shortcode can be used to refer to the relevant chapter:

[ref key="general"]

DEFAULT

 

By default, the abbreviation "ch." is used, your own abbreviation can be specified as follows:

[ref key="lang_examples" pre="chapter"]

chapter

3.5. References to paragraphs

The code <a><href="#p:123">...</a> can be used to link to individual paragraphs (here to paragraph 123) within a post; if the number of paragraphs changes with new versioning, the paragraph number must be adjusted accordingly.

3.6. Notes/Footnotes

The shortcode for annotations is inserted into the text in the editor via the corresponding "Note" button. In the frontend, the content is displayed via MouseOver and additionally set as a linked endnote; in the LateX-generated PDF document, it is set as footnotes.

annotated text[note]This is a note.[/note]

This example results in: annotated text1

Note: In principle, it is also possible to insert footnotes with the shortcode [note content="note"]. However, this leads to various problems, including inverted commas in the footnote text, and should therefore be avoided. In principle, all footnotes must be indicated either with [note]...[/note] or with [note content="..."], both variants at the same time will result in the article being incorrectly formatted.

3.7. Insert literature references

Description follows...

4. Populate bibliography

Description follows...

5. Citations

In-text citations are set with inverted commas as usual, these are displayed in the frontend or in LateX with templates according to the specifications.

Block quotes are tagged with the "Quote" button of the editor, these are also set accordingly.

Example of a blockquote.

6. Formatting texts

For formatting, the standard HTML format classes in the WordPress editor are used.

6.1. Headings

Same for all primary literature types (article / monograph / volume chapter); as a post, a volume chapter has the same structuring as a standalone post; the chapter numbering level is then inserted when the volume is generated as a PDF with LateX; online it is visible via the parent volume, the title in the frontend as well as the outline menu in the sidebar.

  • Title heading (h1-entry-title) = Title (= post title)
    • h1 heading: 1st level of outline (1)
      • h2 heading: 2nd level of outline (1.1)
        • h3 heading: 3rd level of outline (1.1.1)
          • h4 heading: 4th level of outline (1.1.1.1)
            • (h5 = bibliography, will be set automatically)

6.2. Meaning tags

Meaning statements are tagged with the "Declaration of Meaning" button of the editor: To do this, the corresponding word to be tagged is marked with the cursor and then the button is pressed.

Example of a meaning tag.

6.3. Language samples

Language samples are inserted via the "Language sample" button; this generates HTML code (orientation on suggestion at: http://linguistics.stackexchange.com/questions/3/how-do-i-format-an-interlinear-gloss-for-html)

<div class="gloss">
<p class="description">Description</p>
<p class="sentence">Record</p>
<p class="morphological">Glossification (optional)</p>
<p class="free">Translation.</p>
</div>

This code block appears in the editor as follows:

Description

Record

Glossification

Translation.

The placeholders are replaced by your own content; the glossing line can be deleted if superfluous. The numbers and the inverted commas for meaning statements are added via CSS (and are not part of the text, so behave accordingly). Glosses can be marked up as small caps using the text tag {/sc} (in the example: {/sc-1sg.pres}).

Spanish 1a

yo habl-o español

I speak{\sc-1sg.pres} Spanish

I speak Spanish.

The automatic alignment of the glosses is done afterwards by script, the number of tokens in the document line as well as in the glossing line must be identical; between the tokens the space acts as a separator.

The use of the gloss line is optional, it can also be deleted (in this case, no alignment is executed):

Spanish 1b

yo habl-o español

I speak Spanish.

You can also add another line for syntactical markup (a paragraph with class="syntactical"):

Dyirbal 1 (Dixon 1994, 155)

ŋuma yabu-ŋgu bura-n Ø banaga-nyu

father.abs:o mother-erg:A see-nonfut Ø return-nonfut

[O1] [A1] →/TR (S2=O1) →/INTR

Mother saw father and he returned.

Referencing to the examples is not done by the automatically generated numbers, but by the information given in the title line, as this - in contrast to the numbers, which can change on insertion - is a fixed identification label. (Similar to the headings used to identify text segments). These labels can also be used to link to the examples (yet to be implemented).

6.4. Lists

<ol> <li> ... follows

6.5. Tables

follows

6.6. Figures

follows

 

7. Maps

Maps are created using the map shortcode. For this there are the following parameters:

  • lat: geographical latitude
  • lng: geographical longitude
  • zoom: Zoom level. Allowed are integers between 0 and 28
  • width: Width of the map (optional). Allowed are CSS length dimensions, for example 80% or 500px. Default value: 100%
  • height: Height of the map (optional). Allowed are CSS length dimensions, for example 80% or 500px. Default value: 300px

Markers are specified using the marker shortcode within the map shortcode, i.e. between the opening [map]] and the closing [[/map]. Markers can have the following attributes:

  • lat: geographical latitude
  • lng: geographical longitude
  • symbol: Symbol type (optional). There are three possibilities here:
    • Geometric shapes. Allowed are square, triangle, hex (hexagon) and circle.
    • Text. The symbol type specified is text. The actual text is specified via an additional attribute "text" (see below)
    • Numbers. All (positive) numbers are allowed. The number is represented in a circle, which becomes larger (logarithmically) the larger the number is.

    If no symbol type is specified, the marker is displayed as a square.

  • color: Symbol colour (optional). Allowed are CSS colours, for example English colour names (blue, green, red, yellow etc.) or hexadecimal values (#ff0000, #ff00ff etc.). Default value: red
  • size: Size of the symbol (optional). Specifies the radius of the geometric shapes or the text size for text. For numbers, this attribute specifies the "start size" of the circles, i.e. the size of a circle with the value 1. Default value: 10
  • text: Text (optional). Only useful for markers with the type "text". Specifies the actual text that will be displayed on the map
  • border: Thickness of the border (optional). Used only for markers with geometric shapes. Positive numerical values are allowed. For the value 0, the symbol is displayed without a border. Default value: 2

Everything between the opening [marker]] and the closing [/marker] is displayed in a speech bubble when the marker is clicked. Not only text, but also any formatting, images, etc. are possible. The following example gives an overview of the possibilities of the map:

[map lat="51.226623" lng="12.065641" zoom="7" height="500px"]
   [marker lat="50" lng="10" symbol="1" color="green"]test[/marker]
   [marker lat="50" lng="10.5" symbol="2"]Test[/marker]
   [marker lat="50" lng="11" symbol="3"]Test[/marker]
   [marker lat="50" lng="11.5" symbol="4"]Test[/marker]
   [marker lat="50" lng="12" symbol="5"]Test[/marker]
   [marker lat="51" lng="10" symbol="99"]Test[/marker]
   [marker lat="51" lng="11" symbol="100"]Test[/marker]
   [marker lat="51" lng="12.5" symbol="2000"]Test[/marker]
   [marker lat="51" lng="14" symbol="5000"]Test[/marker]
   [marker lat="52" lng="10" symbol="square" color="green"]Test[/marker]
   [marker lat="52" lng="11" symbol="hex" color="yellow"]Test[/marker]
   [marker lat="52" lng="12" symbol="circle" color="yellow"]Test[/marker]
   [marker lat="52" lng="13" symbol="square" color="blue" size="20"]Test[/marker]
   [marker lat="52.5" lng="10" symbol="text" color="purple" size="35" text="Text2"]Test[/marker]
   [marker lat="52.5" lng="12" symbol="text" color="orange" size="20" text="Text"][/marker]
[/map]

8. Preview and publication

If you click on "Preview" in the top right-hand corner, you can see a preview of the post. After you have finished your post, you can publish it by clicking on "Publish" (top right).

9. Miscellaneous

9.1. Bibliographic conversion tools

Format Text to BibteX

Endnote to BibteX

BibteX Online Editor

9.2. Audio player

  • Minimised audio player: A minimised audio player (start or stop button only) can be created by adding the attribute format="min" to the audio shortcode automatically generated by WordPress in text mode.

    Normal audio player (generated via the "Add media" button):

    [audio wav="http://www.kit.gwi.uni-muenchen.de/wp-content/uploads/A_Genova.wav"][/audio]

     

    Minimised audio player:

    [audio format="min" wav="http://www.kit.gwi.uni-muenchen.de/wp-content/uploads/A_Genova.wav"][/audio]

9.3. Old bibliography system

9.3.1. Literature references

For all contributions that did not have a bibliography by the beginning of January 2018, the new bibliography system is in operation. The bibliography can be compiled from existing entries in the database, newly imported Bibtex data or direct input of data via a form. All newly imported bibliographic data will in future be directly available for other contributions. The corresponding citations can still be inserted via the "Bibliography" button. All contributions/volumes with existing bibliographies will (currently) continue to use the old bibliography system, see instructions below.

Literature references are inserted in the editor via the corresponding button "Literaturangabe". The bibliographical data come from the BibTex entries made in the corresponding field in the 'Bibliography' tab of the post. Based on this data, a bibliography is also generated at the end of the post: Literature. To reference one of these bibliographic data via shortcode, its citation key is used, in the following examples with simple author-year scheme (left the shortcode, right the result):

  • Standard format:
    [cite key=dixon2009]
    (Dixon 2009)

     

  • with page reference and "see":
    [cite key=dixon2009 p=1 pre=see]
    (see Dixon 2009, 1)

     

  • 'Author-only' statement, without brackets:
    [cite key=hopper1980 f=author nopar=true]
    Hopper & Thompson

     

  • 'year-only'-statement:
    [cite key=dixon2009 f=year]
    (2009)

     

  • multiple specifications: set individually without brackets (nopar=true) and set brackets by hand:
    (cf. [cite key=hopper1980 nopar=true], [cite key=dixon2009 nopar=true])

    (cf. Hopper & Thompson 1980, Dixon 2009)

     

9.3.2. Bibliography

For all contributions that did not have a bibliography by the beginning of January 2018, the new bibliography system is in operation. The bibliography can be compiled from existing entries in the database, newly imported Bibtex data or direct input of data via a form. All newly imported bibliographic data will in future be directly available for other contributions. The corresponding citations can still be inserted via the "Bibliography" button. All contributions/volumes with existing bibliographies (currently) continue to use the old bibliography system, see instructions below.

The (exchange) format for bibliographic information is BibTeX, currently the information is inserted per post into the corresponding field (the format can be generated by literature management programmes, also e.g. by Zotero, or output during a search e.g. via google scholar; in this case the information should be checked and supplemented if necessary). Later, the individual details are written into the WordPress database via an interface and can thus also be addressed in the text. First, however, the citation key must still be inserted manually (the value of key= in the cite shortcode).

A simple author-year scheme should be preferred here, e.g. dixon2009. Here is a good overview of types of entries and their required and optional fields.

The sample bibliography used in this post:

MONOGRAPHY:
@book{dixon2009, 
  author = {Dixon, Robert M. W.}, 
  year = {2009}, 
  title = {Basic Linguistic Theory 2. Grammatical Topics}, 
  publisher = {Oxford University Press}, 
  address = {New York}, 
}


ARTICLE:

@article{hopper1980,
  title = {Transitivity in Grammar and Discourse},
  author = {Hopper, Paul J. and Thompson, Sandra A.},
  journal = {Language},
  volume = {56},
  number = {2},
  year = {1980},
  pages = {251--299},
}


ARTICLE in ANTHOLOGY / BOOK PART (with own title):

@incollection{maldonado2007,
  address = {Oxford},
  title = {Grammatical Voice in Cognitive Grammar},
  booktitle = {The {{Oxford}} Handbook of Cognitive Linguistics},
  publisher = {{Oxford University Press}},
  author = {Maldonado, Ricardo},
  editor = {Geeraerts, Dirk and Cuyckens, Hubert},
  year = {2007},
}


WEBSITE:

@misc{krefeld2016,
    author = {Krefeld, Thomas},
    url = {https://www.verba-alpina.gwi.uni-muenchen.de/?page_id=493&db=161&letter=D#14},
    note = {Abgerufen am: 21.12.2016},
    title = {Digital Humanities. VA-de 16/1, Methodologie.},
}

 

This is a note.
Dixon, Robert M. W. (2009): Basic Linguistic Theory 2. Grammatical Topics. New York: Oxford University Press.
Hopper, Paul J. & Thompson, Sandra A. (1980): Transitivity in Grammar and Discourse, Language, 251-299.
Krefeld, Thomas: Digital Humanities. VA-de 16/1, Methodologie. https://www.verba-alpina.gwi.uni-muenchen.de/?page_id=493&db=161&letter=D#14. Abgerufen am: 21.12.2016.
Maldonado, Ricardo (2007): Grammatical Voice in Cognitive Grammar. In: Geeraerts, Dirk & Cuyckens, Hubert, The Oxford Handbook of Cognitive Linguistics. Oxford: Oxford University Press.

Leave a Reply