Dokumenty typu PMLA: przewodnik dla użytkownika

Tomasz Przechlewski

tomasz@gnu.univ.gda.pl


Spis treści

Streszczenie
Opis struktury dokumentu
Ogólna struktura dokumentu
Opis pozostałych elementów struktury
Opis elementów wierszowych
Tabele
Rysunki
Odsyłacze i przypisy
Bibliografia i odsyłacze do literatury

Streszczenie

Dokument typu pmla jest przeznaczony do adiustacji dokumentów o nieskomplikowanej strukturze podobnej do uproszczonego dokumentu LaTeXowego. Niniejszy opis przedstawia strukturę i znaczenie poszczególnych elementów dokumentu typu pmla.

Opis struktury dokumentu

Ogólna struktura dokumentu

Dokument zgodny z typem pmla jest zawarty wewnątrz elementu <article> i rozpoczyna się sekwencją następujących elementów: <title>, <author> oraz (opcjonalnie) <email>. Zawierają one kolejno tytuł dokumentu, imię nazwisko autora oraz jego adres email.

<?xml version="1.0" encoding="iso-8859-2" standalone="no"?>
<!DOCTYPE article SYSTEM "pmla.dtd">
<article>
  <title>Tytuł</title>
  <author>Imię Nazwisko</author>
  <email>adres-email</email>
   ...
</article>

Ogólna struktura hierarchiczna dokumentu jest następująca: opcjonalne streszczenie (element <abstract>), tekst zasadniczy (podzielony na punkty (element <section>), opcjonalny spis literatury (<bibliography>) oraz opcjonalny skorowidz (<printindex>). Punkty mogą być z kolei podzielone na podpunkty (<subsection>) oraz podpodpunkty (<subsubsection>). Nie istnieją jednostki podziału hierarchicznego czwartego i kolejnych stopni. Struktura elementu <bibliography> jest omówiona w punkcie Bibliografia i odsyłacze do literatury. Element <printindex> nie ma żadnej zawartości i służy jedynie do wskazania, w którym miejscu dokumentu ma zostać umieszczony skorowidz.

<?xml version="1.0" encoding="iso-8859-2" standalone="no"?>
<!DOCTYPE article SYSTEM "pmla.dtd">
<article>
  ...
    <abstract>
    ...
    </abstract>
    <section>
      <title>...</title>
      <subsection>
	<title></title>
	<para>...</para>
	<para>...</para>
	<subsubsection>
	  <title></title>
	</subsubsection>
      </subsection>
    </section>
    ...
    <bibliography>
    ...
    </bibliography>
</article>

Każdy punkt, podpunkt, itp. rozpoczyna się od wymagalnego elementu <title>.

Opis pozostałych elementów struktury

Elementy strukturalne niższego poziomu składają się na zasadniczą treść każdego elementu podziału hierarchicznego. Są to: akapity (<para>), wyliczenia (<description>, <enumerate><itemize>), rysunki (<figure>), fragmenty tekstu składane literalnie (<verbatim>) i przypisy (<footnote>). Nie ma innych elementów podziału strukturalnego poza wymienionymi.

Dokument typu pmla nie muszą być podzielone na punkty: krótkie dokumenty mogą składać się wyłącznie z elementów wyszczególnych w poprzednim akapicie. Jeżeli jednak są podzielone, to element <section> składa się z wyżej wymienionych elementów (opcjonalnie), po których występują elementy <subsection> (też opcjonalnie). Podobnie <subsection> to opcjonalne akapity wyliczenia itp., po których mogą być umieszczone elementy <subsubsection>. Wreszcie <subsubsection> może się składać wyłącznie z akapitów itp. elementów ponieważ nie ma już elementów podziału niższego poziomu niż trzeci.

Elementy <itemize><enumerate> służą do tworzenia wyliczeń. Każde wyliczenie zawiera jeden lub więcej elementów <item>. Zawartością <item> może być albo jeden lub więcej akapitów (tj. elementów <para>). Można zakładać, że po sformatowaniu poszczególne pozycje w wyliczeniach numerowanych są oznaczone kolejnymi liczbami lub literami alfabetu. Wyliczenia nie mogą być zagnieżdżone. Przykład:

<itemize>
   <item>Słonie</item>
   <item>Lwy</item>
   <item>Antylopy</item>
</itemizedlist>

Wyliczenia typu <description> składają się z jednego lub wielu elementów <descritem>. Element <descritem> składaja się z hasła (jeden lub wiele elementów <term>) i objaśnienia w postaci elementu <descr>. Przykład:

<description>
   <descritem><term>Słoń<term>
     <descr>duże zwierzę z wielką trąbą, mieszka w Afryce</descr>
    </descritem>
   <descritem><term>Lew<term>
     <descr>średniej wielkości zwierzę z długim ogonem, 
      też mieszka w Afryce</descr>
    </descritem>
   <descritem><term>Antylopa<term>
     <descr>średniej wielkości zwierzę z długimi rogami
      również mieszka w Afryce</descr>
    </descritem>
</description>

Elementy <verbatim> zawierają większe fragmenty tekstu, który ma być złożony literalnie, tj. z zachowaniem odstępów i podziału na wiersze. Przykładowo w ten sposób adiustuje się fragmenty programów komputerowych.

Opis elementów wierszowych

Elementy, które mogą wystąpić tylko wewnątrz elementu <para> (a także <title>, <verbatim>, <item> oraz <term>) nazywamy elementami wierszowymi. Należą do nich:

<cite>

cytowanie bibliograficzne, por. punkt Bibliografia i odsyłacze do literatury;

<emph>

wyróżnienie, tj. fragment tekstu, który w druku składa się kursywą (odmianą pochyłą);

<footnote>

przypis, por. punkt Odsyłacze i przypisy;

<index>

hasło do skorowidza;

<verb>

Fragment tekstu składany literalnie, tj. z zachowaniem znaków odstępu i bez przenoszenia wyrazów (Tego typu element zawiera np. fragmenty programów komputerowych itp.);

<url>

odsyłacz do innego dokumentu;

<ref>

odsyłacz do innej części dokumentu.

Tabele

Dokument typu pmla nie umożliwia tworzenia tabel.

Rysunki

Rysunki w tekście wstawiamy wewnątrz elementu <figure>, który składa się z: tytułu (<title>) i elementu <graphic> zawierającego wskazanie (za pomocą atrybutów formatsrc) na plik z rysunkiem. Powyższe elementy i atrybuty są obowiązkowe. Przykład:

<figure>
 <title>Sowa uszata</title>
 <graphic src="sowa.png" format="PNG"/>
</figure>

Odsyłacze i przypisy

Odsyłacze wskazujące na inną część dokumentu definiujemy za pomocą powiązania wartości atrybutu id elementu, do którego odsyłamy z atrybutem src elementu <ref>, który służy do definiowania odsyłacza.

Odsyłacze do dokumentów elektronicznych identyfikowanych za pomocą adresu URL wstawiamy używając do tego elementu <url>. Jako wartość atrybutu src należy podać adres URL (internetowy) dokumentu. Należy podawać pełny adres, tj. rozpoczynać od określenia protokołu, np. http://www.org.pl, a nie www.org.pl. Przykład:

    <section id="ch1">
      <title>Punkt pierwszy</title>
       ...
    </section>
    <section>
      <title>Punkt drugi</title>
      <para>Więcej informacji można znaleźć 
       w <url src="ftp://ftp.dante.de">archiwum CTAN</ulink> 
       i na stronie <url src="www.gust.org.pl"/> oraz
       w rozdziale <ref src="ch1"/>. 
       ...
      </para>
    </section>

Do określenia przypisów używamy elementu <footnote>. Element ten wstawiamy bezpośrednio za fragmentem tekstu, którego dotyczy przypis. Uwaga: polskie zwyczaje wydawnicze nakazują w sytuacji gdy przypis wstawiamy po fragmencie tekstu zakończonym znakiem przestankowym (kropka, przecinek itp) umieszczenie najpierw przypisu a potem wstawienie znaku przestankowego.

Bibliografia i odsyłacze do literatury

Spis literatury składa się z jednego lub więcej elementów <bibitem>. Zawartością tych elementów może być tekst oraz elementy <emph>, <verb>, <ref>, <cite> oraz <title>, które w tym kontekście służy do adiustacji tytułów wymienianych pozycji.

Cytowanie bibliograficzne jest podobne do tworzenia odsyłaczy: atrybut src elementu <cite> ,,wskazuje'' odpowiedni atrybut id elementu <bibitem>. Przykład:

... reguły określone w specyfikacji <cite src="XPath"/>
oraz <cite src="FO"/>s. 45--47</cite>
 są bardziej skomplikowane.
  ...
  <bibliography>
  ...
  <bibitem id="FO">
World Wide Web Consortium:
<title>Extensible Stylesheet Language (XSL)</title>,
patrz <url src="http://www.w3.org/TR/xsl/"/>.
</bibitem>