1 / 24

DITA

DITA. Topic. Topic är grundtypen i DITA. Från den är topics specialiserade i tre varianter: Concept, Task, och Reference. Alla DITA topics delar en gemensam struktur som inkluderar ID-attribut, titel och body. Varför strukturera topics beroende på informationstyp?.

jerica
Télécharger la présentation

DITA

An Image/Link below is provided (as is) to download presentation Download Policy: Content on the Website is provided to you AS IS for your information and personal use and may not be sold / licensed / shared on other websites without getting consent from its author. Content is provided to you AS IS for your information and personal use only. Download presentation by click this link. While downloading, if for some reason you are not able to download a presentation, the publisher may have deleted the file from their server. During download, if you can't get a presentation, the file might be deleted by the publisher.

E N D

Presentation Transcript

  1. DITA

  2. Topic • Topic är grundtypen i DITA. Från den är topics specialiserade i tre varianter: Concept, Task, och Reference. • Alla DITA topics delar en gemensam struktur som inkluderar ID-attribut, titel och body.

  3. Varför strukturera topics beroende på informationstyp? • Meningen är att läsaren direkt ska förstå syftet med den • för att hjälpa dem förstå något • för att hjälpa dem utföra något • för att ge tilläggsinformation

  4. Vilka element finns i de olika topics? Beroende på behov. Exempel: Element Topics

  5. Concept är rotelementet för en topic som svarar på frågan ”vad är?”. Concept topics ger bakgrundsinformation som behövs för att man ska kunna jobba med en produkt på rätt sätt. Concept

  6. Struktur på Concept • Concept är den enklaste specialiseringen av DITA. • Concept kan inkludera paragrafer, listor, och andra element så väl som sektioner och exempel. • Elementet <conbody> har få begränsningar vad gäller användandet av subsections och exempel.

  7. Exempel på Concept topic Operation of pump The lubricating pump is a hydraulically operated piston pump with electric control. The metered amount of oil is determined by electrically altering the pump’s working frequency. The lubricating pump is made up of blocks. The pump consists of one main block with 1-2 auxiliary blocks connected to it (depending on the number of the booms). The main block and each auxiliary block have their own lubrication monitoring switch. Electric control is for the main block only. Monitoring is always activated when operating voltage is switched on. Element Topic

  8. Concept

  9. Concept <?xml version="1.0" encoding="UTF-8"?> <!--Arbortext, Inc., 1988-2007, v.4002--> <!DOCTYPE concept PUBLIC "-//OASIS//DTD DITA Concept//EN" "concept.dtd"> <concept id="concept1"> <title>Operation of pump</title> <conbody> <p>The lubricating pump is a hydraulically operated piston pump with electric control. The metered amount of oil is determined by electrically altering the pump’s working frequency.</p> <p>The lubricating pump is made up of blocks. The pump consists of one main block with 1-2 auxiliary blocks connected to it (depending on the number of the booms). The main block and each auxiliary block have their own lubrication monitoring switch. Electric control is for the main block only. Monitoring is always activated when operating voltage is switched on.</p> </conbody> </concept>

  10. Task • Tasks är byggblock för att skapa information i procedurform. • En task topic innehåller steg-för-steg-instruktioner som beskriver vad som ska göras och i vilken ordning. • Task topic inkluderar sektioner för att beskriva sammanhang, förutsättningar och förväntade resultat.

  11. Struktur på Task • <taskbody> är huvudelementet i en task topic. • Elementet har en specifik struktur, med några valbara men inte obligatoriska element i följande ordning: <prereq>, <context>, <steps>, <result>, <example> och <postreq>. • Varje <step> i aktiviteten måste innehålla ett <cmd> element som beskriver exakt vad användaren måste göra för att fullfölja sin uppgift.

  12. Exempel på Task topic Checking the operation of dosers Check the operation of the dosers approximately one month after system start-up and then at intervals determined by the operating conditions, but not less often than every 6 months. Check for potential excessive or insufficient lubrication and adjust the dosers when necessary. Check procedures 1. Disconnect the lubrication pipes and hoses from the lubrication points. 2. Pressurise the line. 3. Check that the lubricant flows from the lubricant pipes and hoses. 4. Reconnect the lubrication pipes and hoses to the lubrication points. If no lubricant flows from the lubrication pipes or hoses, see the section Troubleshooting. Topic Element

  13. Task i Arbortext

  14. Task som text <?xml version="1.0" encoding="UTF-8"?> <!--Arbortext, Inc., 1988-2007, v.4002--> <!DOCTYPE task PUBLIC "-//OASIS//DTD DITA Task//EN“ "task.dtd"> <task id="task1"> <title>Checking the operation of dosers</title> <taskbody> <context>Check the operation of the dosers approximately one month after system start-up and then at intervals determined by the operating conditions, but not less often than every 6 months. Check for potential excessive or insufficient lubrication and adjust the dosers when necessary.</context> <steps> <step><cmd>Disconnect the lubrication pipes and hoses from the lubrication points.</cmd></step> <step><cmd>Pressurise the line.</cmd></step> <step><cmd>Check that the lubricant flows from the lubricant pipes and hoses.</cmd></step> <step><cmd>Reconnect the lubrication pipes and hoses to the lubrication points.</cmd></step> </steps> <result>If no lubricant flows from the lubrication pipes or hoses, see the section <xref id="Troubleshooting">Troubleshooting</xref>.</result> </taskbody> </task>

  15. Reference • Reference används för att presentera strikt strukturerad data som snabbreferens. • Reference kan innehålla allt som har någorlunda konstant innehåll, så som kommandon, litteraturlistor och kataloger. • Denna information är endast som tillägg till den aktivitet användaren måste utföra.

  16. Struktur på Reference • Huvudinnehållet i en reference är <refbody> • Reference begränsar innehållet till tabeller, listor med egenskaper, syntaxsektioner och allmänna sektioner och exempel.

  17. Exempel på Reference topic Recommended lubricants Use the recommended lubricants or corresponding products from other manufacturers. Element Topic

  18. Reference i Arbortext

  19. Reference som text <?xml version="1.0" encoding="UTF-8"?> <!--Arbortext, Inc., 1988-2007, v.4002--> <!DOCTYPE reference PUBLIC "-//OASIS//DTD DITA Reference//EN” "reference.dtd"> <reference id="reference1"> <title>Lubricants</title> <refbody> <section><title>Recommended lubricants</title><p>Use the recommended lubricants or corresponding products from other manufacturers.</p> <table> <title>Recommended lubricants</title> <tgroup cols="3"><colspec colname="col1" colwidth="0.65*"/><colspec colname="col2” colwidth="0.38*"/><colspec colname="col3" colwidth="1.97*"/> <thead> <row> <entry valign="top">Operation temperature</entry> <entry valign="top">NLGI grade</entry> <entry valign="top">Example</entry> </row> </thead>

  20. Reference som text forts. <tbody> <row> <entry>Below 0°C</entry> <entry>00</entry> <entry><option>Shell Grease Centra W, Mobil Chassis LBZ, Esso Fliessfett S 420 (EGL 3818)</option></entry> </row> <row> <entry>Above 0°C</entry> <entry>2</entry> <entry>Shell Retinax EP2, Mobil HP222, Esso Beacon EP2</entry> </row> </tbody> </tgroup> </table> </section> </refbody> </reference>

  21. Hur gör man? Identifiera vilka task topics som behövs – baserat på användarens behov Identifiera vilka concept och reference topics som behövs för att stödja dessa Skapa, strukturera och publicera (≈ TOCs, playlists)

  22. Bra topics • De använder rubrik (title) syntax för att beskriva informationstyp • De undviker att blanda informationstyper • De fungerar som ett nav, och pekar på relaterade topics (om behov finns) • De fokuserar på en användarfråga

  23. Mer information • DITA Infocenter: http://www.ditainfocenter.com/ • DITA Users: http://www.ditausers.org/ • DITA xml.org: http://dita.xml.org/

More Related