<?xml version="1.0" encoding="iso-8859-2" standalone="no"?>
<!-- $Id: pmlaguide.xml,v 1.1.1.1 2003/01/02 21:00:55 tomek Exp $ -->
<!-- Opis DTD dokumentu typu uproszczona klasa LaTeXowa article,        -->
<!-- czyli poor man latex article [pmla]                                -->
<!-- (c) t. przechlewski, 2002 (tomasz@gnu.univ.gda.pl)                 -->
<!-- Zezwala się na wykorzystanie na warunkach licencji GPL             -->
<!-- patrz: http://www.gnu.org/licenses/gpl.html                        -->

<!DOCTYPE article SYSTEM "pmla.dtd"[
 <!ENTITY % local.inline.class " | sgmltag " >
 <!ELEMENT sgmltag (#PCDATA)               >
 <!ENTITY lt "&#38;#60;"> <!-- LESS-THAN SIGN -->
 <!ENTITY gt "&#x003E;"> <!-- GREATER-THAN SIGN -->
]>
<article>
  <title>Dokumenty typu PMLA: przewodnik dla użytkownika</title>
  <author>Tomasz Przechlewski</author>
  <email>tomasz@gnu.univ.gda.pl</email>
  <abstract>
   <para>
    Dokument typu pmla jest przeznaczony do adiustacji dokumentów
    o nieskomplikowanej strukturze podobnej do uproszczonego dokumentu
    LaTeXowego. Niniejszy <emph>opis</emph> przedstawia strukturę
    i znaczenie poszczególnych elementów dokumentu typu pmla.</para>
  </abstract>
  <section> <title>Opis struktury dokumentu</title>
   <subsection> <title>Ogólna struktura dokumentu</title>
   <para>
    Dokument zgodny z typem pmla jest zawarty wewnątrz elementu
    <sgmltag>article</sgmltag> i rozpoczyna się sekwencją
    następujących elementów: <sgmltag>title</sgmltag>,
    <sgmltag>author</sgmltag> oraz (opcjonalnie)
    <sgmltag>email</sgmltag>. Zawierają one kolejno tytuł dokumentu,
    imię nazwisko autora oraz jego adres email.
   </para>
<verbatim>
&lt;?xml version="1.0" encoding="iso-8859-2" standalone="no"?&gt;
&lt;!DOCTYPE article SYSTEM "pmla.dtd"&gt;
&lt;article&gt;
  &lt;title>Tytuł&lt;/title>
  &lt;author&gt;Imię Nazwisko&lt;/author>
  &lt;email>adres-email&lt;/email>
   ...
&lt;/article&gt;
</verbatim>
   <para>
    Ogólna struktura hierarchiczna dokumentu jest następująca:
    opcjonalne streszczenie (element <sgmltag>abstract</sgmltag>),
    tekst zasadniczy (podzielony na punkty (element
    <sgmltag>section</sgmltag>), opcjonalny spis literatury
    (<sgmltag>bibliography</sgmltag>) oraz opcjonalny skorowidz
    (<sgmltag>printindex</sgmltag>). Punkty mogą być z kolei
    podzielone na <emph>podpunkty</emph>
    (<sgmltag>subsection</sgmltag>) oraz <emph>podpodpunkty</emph>
    (<sgmltag>subsubsection</sgmltag>). Nie istnieją jednostki
    podziału hierarchicznego czwartego i kolejnych stopni. Struktura
    elementu <sgmltag>bibliography</sgmltag> jest omówiona
    w punkcie <ref src="bib"/>. Element <sgmltag>printindex</sgmltag>
    nie ma żadnej zawartości i służy jedynie do wskazania, w którym
    miejscu dokumentu ma zostać umieszczony skorowidz.
   </para>
<verbatim>
&lt;?xml version="1.0" encoding="iso-8859-2" standalone="no"?>
&lt;!DOCTYPE article SYSTEM "pmla.dtd">
&lt;article>
  ...
    &lt;abstract>
    ...
    &lt;/abstract>
    &lt;section>
      &lt;title>...&lt;/title>
      &lt;subsection>
	&lt;title>&lt;/title>
	&lt;para>...&lt;/para>
	&lt;para>...&lt;/para>
	&lt;subsubsection>
	  &lt;title>&lt;/title>
	&lt;/subsubsection>
      &lt;/subsection>
    &lt;/section>
    ...
    &lt;bibliography>
    ...
    &lt;/bibliography>
&lt;/article>
</verbatim>
   <para>
    Każdy punkt, podpunkt, itp. rozpoczyna się od wymagalnego elementu
    <sgmltag>title</sgmltag>.
   </para>
  </subsection>
  <subsection>
    <title>Opis pozostałych elementów struktury</title>
    <para>
     Elementy strukturalne niższego poziomu składają się na zasadniczą
     treść każdego elementu podziału hierarchicznego.  Są to: akapity
     (<sgmltag>para</sgmltag>), wyliczenia
     (<sgmltag>description</sgmltag>, <sgmltag>enumerate</sgmltag>
     i <sgmltag>itemize</sgmltag>), rysunki
     (<sgmltag>figure</sgmltag>), fragmenty tekstu składane literalnie
     (<sgmltag>verbatim</sgmltag>) i przypisy
     (<sgmltag>footnote</sgmltag>).  Nie ma innych elementów podziału
     strukturalnego poza wymienionymi.
   </para>
   <para>
    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
    <sgmltag>section</sgmltag> składa się z wyżej wymienionych
    elementów (opcjonalnie), po których występują elementy
    <sgmltag>subsection</sgmltag> (też opcjonalnie).  Podobnie
    <sgmltag>subsection</sgmltag> to opcjonalne akapity wyliczenia
    itp., po których mogą być umieszczone elementy
    <sgmltag>subsubsection</sgmltag>.  Wreszcie
    <sgmltag>subsubsection</sgmltag> 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.
   </para>
   <para>
    Elementy <sgmltag>itemize</sgmltag> i <sgmltag>enumerate</sgmltag>
    służą do tworzenia wyliczeń. Każde wyliczenie zawiera jeden lub
    więcej elementów <sgmltag>item</sgmltag>. Zawartością
    <sgmltag>item</sgmltag> może być albo jeden lub więcej akapitów
    (tj. elementów <sgmltag>para</sgmltag>).  Można zakładać, że po
    sformatowaniu poszczególne pozycje w wyliczeniach numerowanych są
    oznaczone kolejnymi liczbami lub literami alfabetu.  Wyliczenia
    <emph>nie</emph> mogą być zagnieżdżone. Przykład:
    </para>
<verbatim>
&lt;itemize>
   &lt;item>Słonie&lt;/item>
   &lt;item>Lwy&lt;/item>
   &lt;item>Antylopy&lt;/item>
&lt;/itemizedlist>
</verbatim>
   <para>
    Wyliczenia typu <sgmltag>description</sgmltag> składają się
    z jednego lub wielu elementów <sgmltag>descritem</sgmltag>.
    Element <sgmltag>descritem</sgmltag> składaja się
    z <emph>hasła</emph> (jeden lub wiele elementów
    <sgmltag>term</sgmltag>) i <emph>objaśnienia</emph> w postaci
    elementu <sgmltag>descr</sgmltag>. Przykład:
   </para>
<verbatim>
&lt;description>
   &lt;descritem>&lt;term>Słoń&lt;term>
     &lt;descr>duże zwierzę z wielką trąbą, mieszka w Afryce&lt;/descr>
    &lt;/descritem>
   &lt;descritem>&lt;term>Lew&lt;term>
     &lt;descr>średniej wielkości zwierzę z długim ogonem, 
      też mieszka w Afryce&lt;/descr>
    &lt;/descritem>
   &lt;descritem>&lt;term>Antylopa&lt;term>
     &lt;descr>średniej wielkości zwierzę z długimi rogami
      również mieszka w Afryce&lt;/descr>
    &lt;/descritem>
&lt;/description>
</verbatim>
   <para>
    Elementy <sgmltag>verbatim</sgmltag> 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.
   </para>
  </subsection>
 </section>
 <section> <title>Opis elementów wierszowych</title>
 <para>
  Elementy, które mogą wystąpić tylko wewnątrz elementu
  <sgmltag>para</sgmltag> (a także <sgmltag>title</sgmltag>,
  <sgmltag>verbatim</sgmltag>, <sgmltag>item</sgmltag>
  oraz <sgmltag>term</sgmltag>) nazywamy <emph>elementami
  wierszowymi</emph>. Należą do nich:
 </para>
 <description>
  <descritem>
   <term><sgmltag>cite</sgmltag></term> 
   <descr>
    <para>cytowanie bibliograficzne, por. punkt <ref
   src="bib"/>;</para></descr>
  </descritem>
  <descritem>
   <term><sgmltag>emph</sgmltag></term> <descr><para>wyróżnienie,
   tj. fragment tekstu, który w druku składa się kursywą (odmianą
   pochyłą);</para>
   </descr>
  </descritem>
  <descritem>
    <term><sgmltag>footnote</sgmltag></term> 
    <descr><para>przypis,
	  por. punkt <ref src="xrefs"/>;</para></descr>
  </descritem>
  <descritem>
    <term><sgmltag>index</sgmltag></term>
	  <descr><para>hasło do skorowidza;</para></descr>
    </descritem>
  <descritem>
   <term><sgmltag>verb</sgmltag></term> <descr><para>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.);</para></descr>
  </descritem>
  <descritem>
   <term><sgmltag>url</sgmltag></term>
  <descr><para>odsyłacz do innego dokumentu;</para></descr>
  </descritem>
  <descritem>
    <term><sgmltag>ref</sgmltag></term>
    <descr><para>odsyłacz do innej części dokumentu.</para></descr>
  </descritem>
  </description>
 </section>
 <section> <title>Tabele</title>
  <para>Dokument typu pmla nie umożliwia tworzenia tabel.</para>
 </section>
 <section> <title>Rysunki</title>
  <para>
   Rysunki w tekście wstawiamy wewnątrz elementu
   <sgmltag>figure</sgmltag>, który składa się z: tytułu
   (<sgmltag>title</sgmltag>) i elementu <sgmltag>graphic</sgmltag>
   zawierającego wskazanie (za pomocą atrybutów <verb>format</verb>
   i <verb>src</verb>) na plik z rysunkiem. Powyższe elementy
   i atrybuty są obowiązkowe. Przykład:
  </para>
<verbatim>
&lt;figure>
 &lt;title>Sowa uszata&lt;/title>
 &lt;graphic src="sowa.png" format="PNG"/>
&lt;/figure>
</verbatim>
  </section>
  <section id="xrefs"> <title>Odsyłacze i przypisy</title>
  <para>
   Odsyłacze wskazujące na inną część dokumentu definiujemy za pomocą
   powiązania wartości atrybutu <verb>id</verb> elementu, do którego
   odsyłamy z atrybutem <verb>src</verb> elementu
   <sgmltag>ref</sgmltag>, który służy do definiowania odsyłacza.
  </para>
  <para>
    Odsyłacze do dokumentów elektronicznych identyfikowanych za pomocą
    adresu URL wstawiamy używając do tego elementu
    <sgmltag>url</sgmltag>. Jako wartość atrybutu <verb>src</verb>
    należy podać adres URL (internetowy) dokumentu. Należy podawać
    pełny adres, tj. rozpoczynać od określenia protokołu,
    np. <verb>http://www.org.pl</verb>, a nie <verb>www.org.pl</verb>.
    Przykład:
  </para>
<verbatim>
    &lt;section id="ch1">
      &lt;title>Punkt pierwszy&lt;/title>
       ...
    &lt;/section>
    &lt;section>
      &lt;title>Punkt drugi&lt;/title>
      &lt;para>Więcej informacji można znaleźć 
       w &lt;url src="ftp://ftp.dante.de">archiwum CTAN&lt;/ulink> 
       i na stronie &lt;url src="www.gust.org.pl"/> oraz
       w rozdziale &lt;ref src="ch1"/>. 
       ...
      &lt;/para>
    &lt;/section>
</verbatim>
   <para>
     Do określenia przypisów używamy elementu
     <sgmltag>footnote</sgmltag>. 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 <emph>najpierw</emph> przypisu
     a potem wstawienie znaku przestankowego.
   </para>
  </section>
  <section id="bib">
   <title>Bibliografia i odsyłacze do literatury</title>
   <para>
    Spis literatury składa się z jednego lub więcej elementów
    <sgmltag>bibitem</sgmltag>. Zawartością tych elementów może być
    tekst oraz elementy <sgmltag>emph</sgmltag>,
    <sgmltag>verb</sgmltag>, <sgmltag>ref</sgmltag>,
    <sgmltag>cite</sgmltag> oraz <sgmltag>title</sgmltag>, które w tym
    kontekście służy do adiustacji tytułów wymienianych pozycji.
   </para>
   <para>
    Cytowanie bibliograficzne jest podobne do tworzenia odsyłaczy:
    atrybut <verb>src</verb> elementu <sgmltag>cite</sgmltag>
    ,,wskazuje'' odpowiedni atrybut <verb>id</verb> elementu
    <sgmltag>bibitem</sgmltag>. Przykład:
   </para>
<verbatim>
... reguły określone w specyfikacji &lt;cite src="XPath"/>
oraz &lt;cite src="FO"/>s. 45--47&lt;/cite>
 są bardziej skomplikowane.
  ...
  &lt;bibliography>
  ...
  &lt;bibitem id="FO">
World Wide Web Consortium:
&lt;title>Extensible Stylesheet Language (XSL)&lt;/title>,
patrz &lt;url src="http://www.w3.org/TR/xsl/"/>.
&lt;/bibitem>
</verbatim>
</section>
</article>
<!-- Keep this comment at the end of the file
 Local variables:
 mode: xml
 sgml-indent-step:1
 sgml-indent-data:t
 End:
-->

