![]() |
![]() |
Model de fișier docbookEchipa documentației KDE a pus la dispoziție un fișier model de la care se poate pleca pentru a scrie documentație pentru o aplicație KDE. Mai jos aveți versiunea în limba română a acestui fișier, cu comentariile și tagurile evidențiate pentru a putea fi urmărit mai ușor În caz că vreți să citiți direct versiunea DocBook a acestui fișier, îl puteți lua de aici (template.docbook). (Dați clic dreapta pe legătură (link) și alegeți "Save link as..."). <!DOCTYPE book PUBLIC "-//KDE//DTD DocBook V3.1-Based Variant V1.0//EN" [<!ENTITY kapp "<application>kapp</application>"> <!ENTITY % addindex "IGNORE"> <![ %addindex; [ <!ENTITY kdedocindex SYSTEM "docindex.docbook"> ]]> ]> <!-- kdoctemplate v0.8, 1 Octombrie 1999 --> <!-- Acest model a fost proiectat de: David Rugge davidrugge@mindspring.com, membru al echipei KDE DocBook. Puteți utiliza liber acest model pentru scrierea oricărui tip de documentație KDE. Dacă aveți orice idee de îmbunătățire, spuneți-ne și nouă. Fiți cu atenție, în viitor, majusculele <tagurilor> și atributelor s-ar putea să conteze. De altfel, treceți între ghilimele toate atributele. Nu uitați să eliminiați din documentația dumneavoastră aceste comentarii! --> <!-- Limbajul trebuie schimbat în Book și Keywords pentru translații. Este important să etichetați cartea dumneavoastră cu un ID corespunzător, astfek încît puteți organiza cărțile pe seturi. --> <Book Lang="RO" ID="Kapp"> <!-- Acest antet conține toate meta-informațiile pentru articol, ca de exepmlu autorii, data publicării, abstractul, și cuvintele cheie --> <BookInfo> <Title>Manualul Kapp</Title> <AuthorGroup> <Author> <FirstName>George</FirstName> <OtherName>N.</OtherName> <Surname>Ugnacious</Surname> </Author> </AuthorGroup> <!-- Acesta este un set de cuvinte-cheie ce este folosit de "motoarele" de indexare și căutare de pe Internet (ex: Altavista, Yahoo etc.). Vă rog să introduceți cel puțin KDE, pachetul KDE din care face parte, numele aplicației dumneavoastră și alte cîteva cuvinte-cheiea relevante. --> <KeywordSet Lang="RO"> <Keyword>KDE</Keyword> <Keyword>Kapp</Keyword> <Keyword>kdeutils</Keyword> <Keyword>nimic</Keyword> <Keyword>neutilizabil</Keyword> </KeywordSet> <!-- Informații și o scurtă istorie a reviziilor documentației. Istoria versiunilor aplicației trebuie pusă în introducere. Încercați să țineți această secțiune cît mai scurtă, dar introduceți măcar o versiune și data. În acest fel, translatorii vor putea compare ultima versiune translatata cu ultima versiune în engleză. --> <ReleaseInfo>Acest manual descrie Kapp versiunea 1.1</ReleaseInfo> <RevHistory> <Revision> <RevNumber>1.1 </RevNumber> <Date>3.4.1999</Date> <AuthorInitials>G.N.U.</AuthorInitials> <RevRemark>Am corectat cîteva erori. </RevRemark> </Revision> <Revision> <RevNumber>1.0 </RevNumber> <Date>3.4.1999</Date> <AuthorInitials>G.N.U.</AuthorInitials> <RevRemark>Prima lansare a aplicației. </RevRemark> </Revision> </RevHistory> <!-- Abstractul despre acest manual --> <Abstract> <Para> Kapp este o aplicație special făcută să nu facă nimic din ceea ce ai dori. </Para> </Abstract> </BookInfo> <!-- Conținutul documentului începe aici. Etichetați fiecare secțiune astfel încît să aibă atributul ID. Aceasta este necesară din două motive: ea permite să faceți foarte rapid referință la secțiune din alte secțiuni ale documentului dumneavoastră și dacă nu există un ID, numele fișierelor HTML generate vor varia din timp în timp ceea ce va îngreuna munca întreținătorilot și sistemului CVS. Orice secțiune etichetată (OPTIONAL) este lăsată la discreția autorului. Celelalte secțiuni ar trebui să nu fie ignorate pentru a menține un stil uniform al documentațiilor pentru toate aplicațiile KDE. --> <Chapter ID="Introduction"> <Title>Introducere</Title> <!-- Secțiunea introductivă conține o scurtă introducere pentru aplicație care explică ceea ce face, de unde se poate procura o nouă versiune, unde se pot raporta problemele și o scurtă instorie a reviziilor aplicației. Practic, ea este o versiune mai lungă a abstractului. --> <Para> Kapp este un program care vă permite să nu faceți absolut nimic. Vă rugăm să raportați orice problemă, cerere de îmbunătățire, în listele de discuții KDE.</Para> <Sect1> <Title>Cum se obține Kapp</Title> <Para> Kapp face parte din proiectul KDE <ULink URL="http://www.kde.org">http://www.kde.org</ULink>. Kapp poate fi găsit în pachetul kdeutils la <ULink URL="ftp://ftp.kde.org/pub/kde/">ftp://ftp.kde.org/pub/kde/</ULink>, site-ul FTP principal al KDE. </Para> </Sect1> <!-- Trebuie să observați că tagurile revhistory se aplică versiunii documentației și nu versiunii aplicației. Din această cauză utilizez aici ItemizedList. --> <Sect1> <Title>Istoria versiunilor Kapp</Title> <Para> <ItemizedList> <ListItem> <Para>1.1 - fixat bug-ul care determina dispariția ferestrei, adăugat o grămadă de noi opțiuni.</Para></ListItem> <ListItem><Para>1.0 - prima distribuire către public</Para></ListItem> </ItemizedList> </Para> </Sect1> </Chapter> <Chapter ID="Requirements"> <Title>Cerințe</Title> <!-- Listați aici orice cerințe speciale pentru aplicația dumneavoastră. Acestea ar trebui să includă: .Librăriile sau alt software care nu este inclus în kdesupport, kdelibs sau kdebase. .Cerințele hardware ca de exemplu cantitatea de RAM, spațiu de disk, capabilități ale placii grafice, rezoluția ecranului, alte plăci de extensie speciale etc. .Sistemul de operare sub care va rula aplicația. Dacă aplicația dumneavoastră este proiectată numai sub un OS specific, (ați scris un configurator de LILO grafic, de exemplu) scrieți această informație aici. --> <Para> Pentru a utiliza cu succes Kapp, aveți nevoie de KDE 1.1. Este nevoie de foobar.lib pentru a suporta capabilitățile avansate ale Kapp. Kapp utilizează aproape 5M de memorie pentru a rula, dar aceasta poate varia depinzînd de configurația platformei dumneavoastră. </Para> <Para> Toate librăriile de care are nevoie Kapp pot fi găsite la <ULink URL="ftp://ftp.kapp.org">Pagina de WEB a Kapp</ULink>. </Para> </Chapter> <Chapter ID="Using-Kapp"> <Title>Utilizarea Kapp</Title> <!-- Această secțiune ar trebui să explice utilizatorului cum să utilizeze aplicația dumneavoastră. Puteți utiliza atîtea secțiuni (Chapter, Sect1, Sect3, etc...) cîte considerați necesare pentru a documenta în întregime aplicația. --> <Para> <!-- Rețineți că toate imaginile trebuie să fie în formatul .PNG. Nu utilizați GIF-uri datorită problemelor de licențiere. --> <ScreenShot> <ScreenInfo>Aici este o imagine a Kapp</ScreenInfo> <Graphic FileRef="screenshot.png" Format="png"></Graphic> </ScreenShot> </Para> <Sect1> <Title>Alte caracteristici ale Kapp</Title> <Para>Taie în felii! Joacă zaruri! Și vine și cu un prăjitor de pîine gratuit! </Para> <Para> Unealta Squiggle <GUIIcon><InlineGraphic FileRef="squiggle.png" Format="png"></InlineGraphic></GUIIcon> este utilizată să deseneze linii squiggly pe întreaga suprafata a ferestrei principale a Kapp. Nu este un bug, este o facilitate reală! </Para> </Sect1> </Chapter> <Chapter ID="Commands"> <Title>Command Reference</Title> <!-- (OPȚIONAL, DAR RECOMANDAT) Această secțiune ar trebui să listeze toate comenziile din bara de unelte și meniuri pentru ca o referință cît mai ușoară pentru utilizator. Mai include și tastele care au o funcție specială dar nu au nici un echivalent în barele de unelte sau meniuri. Această secțiune poate să nu fie necesară pentru aplicații mici sau care nu au meniuri sau bară de unelte. --> <Para></Para> <Sect1> <Title>Fereastra principală a Kapp</Title> <Para></Para> <Sect2> <Title>Meniul Fișier</Title> <Para> <VariableList> <VarListEntry> <Term> <MenuChoice> <Shortcut> <KeyCombo><KeyCap>Ctrl</KeyCap><KeyCap>n</KeyCap></KeyCombo> </Shortcut> <GUIMenu>Fișier</GUIMenu> <GUIMenuItem>Nou</GUIMenuItem> </MenuChoice> </Term> <ListItem> <Para> Creează un document nou </Para> </ListItem> </VarListEntry> <VarListEntry> <Term> <MenuChoice> <Shortcut> <KeyCombo><KeyCap>Ctrl</KeyCap><KeyCap>s</KeyCap></KeyCombo> </Shortcut> <GUIMenu>Fișier</GUIMenu> <GUIMenuItem>Salvează</GUIMenuItem> </MenuChoice> </Term> <ListItem> <Para> Salvează documentul </Para> </ListItem> </VarListEntry> <VarListEntry> <Term> <MenuChoice> <Shortcut> <KeyCombo><KeyCap>Ctrl</KeyCap><KeyCap>q</KeyCap></KeyCombo> </Shortcut> <GUIMenu>Fișier</GUIMenu> <GUIMenuItem>Termină</GUIMenuItem> </MenuChoice> </Term> <ListItem> <Para> Termină aplicația Kapp </Para> </ListItem> </VarListEntry> </VariableList> </Para> </Sect2> </Sect1> </Chapter> <Chapter ID="Developers"> <Title>Ghidul dezvoltatorilor Kapp</Title> <!-- (OPȚIONAL) Ar trebui utilizată o secțiune de referințe de programare/scripting pentru aplicațiile ce utilizează plugin-uri sau care asigură propriile metode de scripting și/sau librării de dezvoltare. --> <Para> Programarea unui plugin pentru Kapp este o distracție. Trebuie numai să citiți următoarele 66 de pagini ale API-ului ca să învătați cum să faceți! </Para> <!-- Utilizați refentries pentru a descrie un API. Refentries-urile sînt relativ complicate și ar trebui să consultați o carte de referință `docbook' pentru mai multe detalii. Exemplul de mai jos a fost luat dintr-o astfel de carte și a fost scurtat pentru a putea fi citit mai ușor. --> <RefEntry ID="RE-1007-UNMANAGECHILDREN-1"> <RefMeta> <RefEntryTitle> XtUnmanageChildren </RefEntryTitle> <RefMiscInfo> Xt - Managementul geometriei </RefMiscInfo> </RefMeta> <RefNameDiv> <RefName> XtUnmanageChildren </RefName> <RefPurpose> elimină o listă de fii dintr-o listă de widget-uri administrată de părinte </RefPurpose> <IndexTerm ID="IX-1007-UNMANAGECHILDREN-1"><PRIMARY>widget</PRIMARY> <SECONDARY>eliminare</SECONDARY></IndexTerm> <IndexTerm ID="IX-1007-UNMANAGECHILDREN-2"><PRIMARY>XtUnmanageChildren</PRIMARY> </IndexTerm> </RefNameDiv> <RefSynopsisDiv> <RefSynopsisDivInfo> <Date> 4 Martie 1996 </Date> </RefSynopsisDivInfo> <Synopsis> void XtUnmanageChildren(<Replaceable CLASS="ParaMETER">fiu</Replaceable>, <Replaceable CLASS="ParaMETER">numar_fii</Replaceable>) WidgetList <Replaceable CLASS="ParaMETER">fiu</Replaceable>; Cardinal <Replaceable CLASS="ParaMETER">numar_fii</Replaceable>; </Synopsis> <RefSect2 ID="R2-1007-UNMANAGECHILDREN-1"> <Title> Parametrii </Title> <VariableList> <VarListEntry> <Term> <Replaceable CLASS="ParaMETER"> fiu </Replaceable> </Term> <ListItem> <Para> Specifică un vector de widget-uri fiu. Fiecare fiu trebuie să facă parte din clasa RectObj sau orice subclasă a lui. </Para> </ListItem> </VarListEntry> <VarListEntry> <Term> <Replaceable CLASS="ParaMETER"> numar_fii </Replaceable> </Term> <ListItem> <Para> Specifică numărul de elemente din <Replaceable CLASS="ParaMETER">fiu</Replaceable>. </Para> </ListItem> </VarListEntry> </VariableList> </RefSect2> </RefSynopsisDiv> <RefSect1 ID="R1-1007-UNMANAGECHILDREN-1"> <Title> Descriere </Title> <Para> <Function>XtUnmanageChildren()</Function> demapează widget-urile specificate și le elimină din managementul geometriei părintelui. Widget-urile vor dispărea de pe ecran și (depinzînd de părinte) nu vor mai avea spațiu alocat pe ecran. </Para> <Para> Fiecare din widget-urile din vector <Replaceable CLASS="ParaMETER">fiu</Replaceable> trebuie să aibă același părinte. </Para> <Para> Citiți secțiunea "Algoritm" de mai jos pentru mai multe detalii despre procedurile de eliberare a widget-urilor. </Para> </RefSect1> <RefSect1 ID="R1-1007-UNMANAGECHILDREN-2"> <Title> Utilizare </Title> <Para> De-administrînd widget-urile este metoda uzuală de a le face temporar invizibile. Ele pot fi re-administrate cu funcția <Function>XtManageChildren()</Function>. </Para> <Para> Puteți demapa un widget, dar să-l lăsați sub administrarea geometriei apelînd <Function>XtUnmapWidget()</Function>. Puteți șterge un widget din fereastră fără a distruge widget-ul apelînd <Function>XtUnrealizeWidget()</Function>. Puteți distruge un widget complet cu <Function>XtDestroyWidget()</Function>. </Para> <Para> Dacă doriți să renunțați la un singur widget, este mult mai indicat să apelați la <Function>XtUnmanageChild()</Function>. Este adesea mult mai convenabil să apelați <Function>XtUnmanageChild()</Function> de mai multe ori decît să declarați și să inițializați un vector de widget-uri pentru a apela <Function>XtUnmanageChildren()</Function>. Apelînd <Function>XtUnmanageChildren()</Function> este mult mai eficient, oricum, deoarece ea apelează numai odată funcția <Function>change_managed()</Function> a părintelui. </Para> </RefSect1> <RefSect1 ID="R1-1007-UNMANAGECHILDREN-3"> <Title> Algoritm </Title> <Para> <Function>XtUnmanageChildren()</Function> execută următoarele: </Para> <VariableList> <VarListEntry> <Term> - </Term> <ListItem> <Para> Ignoră procesul fiu dacă este deja neadministrat sau a fost distrus. </Para> </ListItem> </VarListEntry> <VarListEntry> <Term> - </Term> <ListItem> <Para> Altfel, dacă procesul fiu este generat, îl face invizibil prin demapare. </Para> </ListItem> </VarListEntry> </VariableList> <Para> </Para> </RefSect1> <RefSect1 ID="R1-1007-UNMANAGECHILDREN-4"> <Title> Structuri </Title> <Para> Tipul <TYPE>WidgetList</TYPE> este un vector simplu de widget-uri: </Para> <SCREEN ID="SC-1007-UNMANAGECHILDREN-1"> typedef Widget *WidgetList; </SCREEN> </RefSect1> </RefEntry> </Chapter> <Chapter ID="FAQ"> <Title>Întrebări și răspunsuri</Title> <!-- (OPȚIONAL dar recomandat) Această secțiune ar trebui să includă toate întrebările prostești ale noviciilor (dar nu prea prostești) care vă asaltează cu e-mail-uri. Această secțiune ar trebui rezervată pentru întrebări și răspunsuri SCURTE! Dacă o întrebare are nevoie de mai mult de o pagină pentru un răspuns, atunci ar trebui să facă parte din secțiunea "Utilizarea aplicației". Ar trebui să utilizați link-uri pentru a referi întrebările la părți din documentație care răspund la ele. Acesta este un loc foarte bun pentru alte link-uri către documente ce conțin întrebări și răspunsuri, dacă utilizatorul dumneavoastră trebuie să facă operații complicate pentru a configura alte programe pentru ca aplicația dumneavoastră să funcționeze. --> <Para></Para> <QandASet> <QandAEntry> <Question> <Para> Mouse-ul meu nu merge. Cum să închid aplicația Kapp? </Para> </Question> <Answer> <Para> Sînteți neatent! Citiți <Link LinkEnd="Commands">secțiunea de comenzi</Link> pentru a afla răspunsul. </Para> </Answer> </QandAEntry> <QandAEntry> <Question> <Para> Cum pot să-mi twiddle documentele? </Para> </Question> <Answer> <Para> Puteți să twiddle documentele dumneavoastră numai dacă aveți instalată librăria foobar.lib. </Para> </Answer> </QandAEntry> </QandASet> </Chapter> <Chapter ID="Credits"> <!-- Include credite pentru programatori, scriitorii documentației și cei care au contribuit la aplicație. Licența pentru aplicație trebuie inclusă mai jos de credite cu o referință către fișierul de licență corespunzător inclus în distribuția KDE. --> <Title>Credite și licențe</Title> <Para> Kapp </Para> <Para> Copyright 1997 pentru programul lui John Q. Hacker <Email>jqh@kde.org</Email> </Para> <Para> Contributori: <ItemizedList> <ListItem><Para>Konqui, dragonul KDE <Email>kongy@kde.org</Email></Para> </ListItem> <ListItem><Para>Tux, pinguinul <Email>tux@linux.org</Email></Para> </ListItem> </ItemizedList> </Para> <Para> Copyright 1999 pentru documentația de George N. Ugnacious <Email>gnu@kde.org</Email> </Para> <Para> Translații făcute de: <ItemizedList> <ListItem> <Para>Babel D. Fish <Email>babelfish@kde.org</Email> (sanskrită)</Para> </ListItem> </ItemizedList> </Para> <!-- For URL links to common stuff like the one below, always use paths like "common/gpl-licence". In this path, "common" will be a symbolic link built at "make install" time. This link will normally point to $KDEDIR/share/doc/HTML/en/common, where "en" should be replaced with the current language. --> <!-- Pentru link-uri URL la fișiere comune cum este cel de mai jos utilizați întotdeauna căi precum "common/gpl-licence". În această cale, "common" va fi o legătură simbolică la link-ul făcut la momentul cînd ați dat comanda "make install". Acesta indică întotdeauna directorul $KDEDIR/share/doc/HTML/ro/common. --> <Para> Acest program este licențiat sub termenii <ULink URL="common/gpl-licence.html">GNU GPL</ULink>. </Para> </Chapter> <![ %addindex; [ &kdedocindex; ]]> </Book> |
Ultimul autor: | Claudiu Costin |
Ultima actualizare: | 2 decembrie 1999 |