Skip to content

Working dita #1

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
Techwriter2017 wants to merge 5 commits into
base: master
Choose a base branch
from
Open

Working dita #1

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
221d5d9
fhhfhfhf
Techwriter2017 Mar 17, 2017
31976d7
Changed RST to DITA
Techwriter2017 Apr 6, 2017
db3cec2
test change
Techwriter2017 Apr 6, 2017
cfd3269
more tests
Techwriter2017 Apr 6, 2017
62bcddf
Create Dita map file
Techwriter2017 Apr 6, 2017
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
61 changes: 61 additions & 0 deletions DITA-CH.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,61 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- This file is part of the DITA Open Toolkit project hosted on
Sourceforge.net. See the accompanying license.txt file for
applicable licenses.-->
<!-- (C) Copyright IBM Corporation 2001, 2005. All Rights Reserved.
*-->
<!DOCTYPE concept
PUBLIC '-//OASIS//DTD DITA Concept//EN'
'dtd1.2/technicalContent/dtd/concept.dtd'>

<concept id="sample_concept" xml:lang="en-US">
<author>Cathie Ryan</author>
<title>Chapter 4: Writing Collaboratively</title>
<shortdesc>Summary of Chapter 4 contents about writing collaboratively.</shortdesc>
<conbody>
<p>Technical writers are often employed by corporations and assigned to work on team to produce
documentation. </p>
<p>In these corporations, it is necessary for the writer to know how to collaborate with the
team. </p>
<p>When collaboration is done correctly, the documentation is better.</p>
<p>Our text book lists several advantages and disadvantages to collaboration. With
collaboration, </p>
<p>the writer can draw upon a wider knowledge and skills base. The documentation also benefits
by having </p>
<p>another person review it to make sure that it is accurate, clear, and targeted to the
intended audience. </p>
<p>Also, collaboration improves communication in the team, acclimates new writers, and improves
moral. </p>
<p>Collaboration does have disadvantages in time, interpersonal conflict, and other areas.
However, if </p>
<p>the writer conducts themselves in a professional manner, the disadvantages of collaboration
are manageable.</p>
<p>Documentation projects benefit from being planned and monitored through the process. Before
writing </p>
<p>begins, it is advisable to create a documentation plan that lists what will be written, by
whom, and </p>
<p>contain a detailed schedule with milestones such as the date when the document will be
drafted, reviewed, </p>
<p>published, and so on. Some documentation plans may include a list of risks or dependencies
that detail </p>
<p>the circumstances that impact successful completion of any and all milestones. Also, if the
documentation </p>
<p>is being written by many writers, it is best to define individual tasks for each writer and
establish a style </p>
<p>sheet, a glossary as well as the work schedules and procedures to coordinate the team’s
efforts.</p>
<p>In the career of technical writing, writers will have to attend many meetings. To be
successful, </p>
<p>the writer should be prepared for the meeting with appropriate questions, listen effectively,
and give </p>
<p>feedback. It is important to be professional and diplomatic when giving feedback.</p>
<p>Lastly, technical writers need to understand the various social media services available. </p>
<p>For example:</p>
<ul id="ul_hqw_kkc_mz">
<li>Videoconferencing as a way to meet and share information.</li>
<li>Online information sources such as tweets, wikis, websites, Facebook, YouTube, and
more.</li>
<li>Different types of writing (aka authoring) software and online review.</li>
</ul>
</conbody>
</concept>
19 changes: 19 additions & 0 deletions DITA-CH4-reference-example.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE reference PUBLIC
'-//OASIS//DTD DITA Reference//EN'
'dtd1.2/technicalContent/dtd/reference.dtd'>

<!-- This file is part of the DITA Open Toolkit project. See the accompanying LICENSE file for applicable license. -->

<reference id="troubleshooting" xml:lang="en-US">
<title>Glossary of Terms</title>
<shortdesc>From <i>Technical Communication</i> by Mike Markel.</shortdesc>
<refbody>
<section id="out-of-memory-error">
<title>Audience Profile Sheet</title>
<p>A document that records characteristics of the audience. For example, the audience profile
sheet could include education level, job responsibilites, type of work environment, cultural
characteristics and many more.</p>
</section>
</refbody>
</reference>
35 changes: 35 additions & 0 deletions DITA-CH4-task-example.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,35 @@
<?xml version="1.0" encoding="utf-8"?>
<!DOCTYPE task
PUBLIC '-//OASIS//DTD DITA Task//EN'
'dtd1.2/technicalContent/dtd/task.dtd'>
<!-- This file is part of the DITA Open Toolkit project hosted on
Sourceforge.net. See the accompanying license.txt file for
applicable licenses.-->
<!-- (C) Copyright IBM Corporation 2001, 2005. All Rights Reserved.
*-->
<task id="changeoil" xml:lang="en-us">
<title>Writing Process</title>
<shortdesc>From <i>Technical Communication</i> by Mike Markel.</shortdesc>
<taskbody>
<context>
<p>Typical steps when writing technical documentation. </p>
</context>
<steps>
<step>
<cmd>Planning</cmd>
</step>
<step>
<cmd>Drafting.</cmd>
</step>
<step>
<cmd>Revising.</cmd>
</step>
<step>
<cmd>Editing.</cmd>
</step>
<step>
<cmd>Proofreading.</cmd>
</step>
</steps>
</taskbody>
</task>
61 changes: 61 additions & 0 deletions DITA-CH4.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,61 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- This file is part of the DITA Open Toolkit project hosted on
Sourceforge.net. See the accompanying license.txt file for
applicable licenses.-->
<!-- (C) Copyright IBM Corporation 2001, 2005. All Rights Reserved.
*-->
<!DOCTYPE concept
PUBLIC '-//OASIS//DTD DITA Concept//EN'
'dtd1.2/technicalContent/dtd/concept.dtd'>

<concept id="sample_concept" xml:lang="en-US">
<author>Cathie Ryan</author>
<title>Chapter 4: Writing Collaboratively</title>
<shortdesc>Summary of Chapter 4 contents about writing collaboratively.</shortdesc>
<conbody>
<p>Technical writers are often employed by corporations and assigned to work on team to produce
documentation. </p>
<p>In these corporations, it is necessary for the writer to know how to collaborate with the
team. </p>
<p>When collaboration is done correctly, the documentation is better.</p>
<p>Our text book lists several advantages and disadvantages to collaboration. With
collaboration, </p>
<p>the writer can draw upon a wider knowledge and skills base. The documentation also benefits
by having </p>
<p>another person review it to make sure that it is accurate, clear, and targeted to the
intended audience. </p>
<p>Also, collaboration improves communication in the team, acclimates new writers, and improves
moral. </p>
<p>Collaboration does have disadvantages in time, interpersonal conflict, and other areas.
However, if </p>
<p>the writer conducts themselves in a professional manner, the disadvantages of collaboration
are manageable.</p>
<p>Documentation projects benefit from being planned and monitored through the process. Before
writing </p>
<p>begins, it is advisable to create a documentation plan that lists what will be written, by
whom, and </p>
<p>contain a detailed schedule with milestones such as the date when the document will be
drafted, reviewed, </p>
<p>published, and so on. Some documentation plans may include a list of risks or dependencies
that detail </p>
<p>the circumstances that impact successful completion of any and all milestones. Also, if the
documentation </p>
<p>is being written by many writers, it is best to define individual tasks for each writer and
establish a style </p>
<p>sheet, a glossary as well as the work schedules and procedures to coordinate the team’s
efforts.</p>
<p>In the career of technical writing, writers will have to attend many meetings. To be
successful, </p>
<p>the writer should be prepared for the meeting with appropriate questions, listen effectively,
and give </p>
<p>feedback. It is important to be professional and diplomatic when giving feedback.</p>
<p>Lastly, technical writers need to understand the various social media services available. </p>
<p>For example:</p>
<ul id="ul_hqw_kkc_mz">
<li>Videoconferencing as a way to meet and share information.</li>
<li>Online information sources such as tweets, wikis, websites, Facebook, YouTube, and
more.</li>
<li>Different types of writing (aka authoring) software and online review.</li>
</ul>
</conbody>
</concept>
64 changes: 64 additions & 0 deletions DITA-CH6.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,64 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- This file is part of the DITA Open Toolkit project hosted on
Sourceforge.net. See the accompanying license.txt file for
applicable licenses.-->
<!-- (C) Copyright IBM Corporation 2001, 2005. All Rights Reserved.
*-->
<!DOCTYPE concept
PUBLIC '-//OASIS//DTD DITA Concept//EN'
'dtd1.2/technicalContent/dtd/concept.dtd'>

<concept id="sample_concept" xml:lang="en-US">
<author>Cathie Ryan</author>
<title>Chapter 6: Researching Your Subject</title>
<shortdesc>Summary from <i>Technical Communication</i> by Mike Markel.</shortdesc>
<conbody>
<p>The main purpose of searching a subject is to get answers to questions. You may need an
answer to a </p>
<p>practical question such as “Should tablets replace notebooks in the workplace?”.
Alternatively, you may </p>
<p>need to answer scholarly questions. Whether you are searching for answers to practical
questions or </p>
<p>scholarly questions, your research will fall into two main types:</p>
<ul id="ul_xgj_qlc_mz">
<li>Primary research—research where you discover or create the information yourself.</li>
<li>Secondary research—you find information that other people have discovered or created.</li>
</ul>
<p>Good research is planned. The audience, purpose, and subject need to be analyzed to narrow
down the </p>
<p>scope of the project. Budgets, time schedules and the form of the final documentation need to
be worked out. </p>
<p>You will essential to determine how much to research, how much research will actually be
summarized in the </p>
<p>document, and how much research is needed to provide you with enough background knowledge
that you can </p>
<p>understand and write to your audience.</p>
<p> Before you start researching, it is helpful to write out the questions that you need to
answer. </p>
<p>Then you will need to be persistent to find the answers to your questions. You will want to
have a system </p>
<p>for recording or managing the information that you find. Finally, you will want to make sure
that you have </p>
<p>triangulated the information. That means that you found 3 different sources that answer the
question in </p>
<p>three different ways. </p>
<p> You can find information in traditional form, online social media, or forms that you
generate yourself:</p>
<ul id="ul_bkb_tlc_mz">
<li>Traditional form includes print, online databases or catalogs, reference works,
periodicals, newspapers, </li>
<li>abstracts, and government information. </li>
<li>Online social media includes online discussion boards, wikis, blogs, tagged content, and
RSS feeds. You </li>
<li>will need to evaluate the information that you find for accuracy, bias, completeness,
appropriateness, </li>
<li>clarity, and timeliness. </li>
<li>Forms that you generate yourself include observations, field research, inspections,
demonstrations </li>
<li>(as the case with software programs), interviews, questionnaires, inquiries, and
surveys.</li>
<li> Regardless of where you get the research, it must be accurate and you must be honest in
how you use it.</li>
</ul>
</conbody>
</concept>
34 changes: 34 additions & 0 deletions DITA-CH9.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,34 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- This file is part of the DITA Open Toolkit project hosted on
Sourceforge.net. See the accompanying license.txt file for
applicable licenses.-->
<!-- (C) Copyright IBM Corporation 2001, 2005. All Rights Reserved.
*-->
<!DOCTYPE concept
PUBLIC '-//OASIS//DTD DITA Concept//EN'
'dtd1.2/technicalContent/dtd/concept.dtd'>

<concept id="sample_concept" xml:lang="en-US">
<author>Cathie Ryan</author>
<title>Chapter 9: Emphasizing Important Information</title>
<shortdesc>Summary from <i>Technical Communication</i> by Mike Markel.</shortdesc>
<conbody>
<p>This chapter taught us about how to write so that important information is easily accessible
and understood. Here are some important points:</p>
<ul id="ul_k5r_lmc_mz">
<li>Make sure that the titles and headings are informative. The titles and headings should
describe the section, and be indented id a way to highlight relative importance of the
information.</li>
<li>Separate out the important information into a list. The list can have the important phases
bolded and can have explanatory sentences following the bolded phrases.</li>
<li>Structure paragraphs so that the important information comes first. Then, any supporting
sentences can follow.</li>
<li>Divide paragraphs into manageable chunks. Find logical places to break paragraphs into
fewer sentences so that there is not so much information for the reader to understand or
remember.</li>
<li>Use transitional word and phases to convey meaning. Transitional words show relationships
and include words like also, likewise, although, above, and finally among many other words
listed on page 209.</li>
</ul>
</conbody>
</concept>
8 changes: 8 additions & 0 deletions DITA_MAP
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
<map>
<topicref href="DITA-CH4.xml">
<topicref href="DITA-CH6.xml">
<topicref href="DITA-CH9.xml">
<topicref href="DITA-CH4-task-example.xml">
<topicref href="DITA-CH4-reference-example.xml">

</map>
13 changes: 8 additions & 5 deletions concept-example.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,11 +9,14 @@
'dtd1.2/technicalContent/dtd/concept.dtd'>

<concept id="sample_concept" xml:lang="en-US">
<author>Your name</author>
<title>My Abstract</title>
<shortdesc>My Abstract</shortdesc>
<author>Cathie Ryan</author>
<title>JavaScript</title>
<shortdesc>Programming language that turns your webpages into a program. test</shortdesc>
<conbody>
<p>First paragraph</p>
<p>Second paragraph</p>
<p>JavaScript is a programming language that you use with your webpages to turn webpages into a
program. It allows the developer to gather input and manipulate the webpage after the webpage
has been loaded. </p>
<p>Javascript is deeply embedded with the browser. It uses an event driven model which means
that the event is not run until the event is triggered.</p>
</conbody>
</concept>
18 changes: 7 additions & 11 deletions reference-example.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,26 +6,22 @@
<!-- This file is part of the DITA Open Toolkit project. See the accompanying LICENSE file for applicable license. -->

<reference id="troubleshooting" xml:lang="en-US">
<title>Other error messages</title>
<shortdesc>In addition to error messages generated by the DITA Open Toolkit, you might also encounter error messages
generated by Java or other tools.</shortdesc>
<title>JavaScript Events</title>
<shortdesc>Triggers the execution of the event that affect the webpage. test</shortdesc>
<refbody>
<section id="out-of-memory-error">
<title>Out of Memory error</title>
<p>In some cases, you might receive a message stating the build has failed due to an <msgph>Out of Memory</msgph>
error. Try the following approaches to resolve the problem:</p>
<ol>
<li>Increase the memory available to Java.</li>
<li>Reduce memory consumption by setting the <option>generate-debug-attributes</option> option to
<codeph>false</codeph>. This option is set in the <filepath>lib/configuration.properties</filepath> file.
This will disable debug attribute generation (used to trace DITA-OT error messages back to source files) and
will reduce memory consumption.</li>
<li>Set <codeph>dita.preprocess.reloadstylesheet</codeph> Ant property to <codeph>true</codeph>. This will allow
the XSLT processor to release memory when converting multiple files.</li>
<li>Run the transformation again.</li>
<li>Loading the webpage.</li>
<li>Leaving the webpage.</li>
<li>Clicking a link. </li>
<li>Scrolling up or down.</li>
</ol>
</section>
<section id="java-io-exception">
<title>Specific JavaScript Error List</title>
<title>java.io.IOException: Can't store Document</title>
<p>After running a JavaHelp transformation, you may receive a <msgph>java.io.IOException: Can't store
Document</msgph> message. </p>
Expand Down
24 changes: 12 additions & 12 deletions task-example.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,33 +8,33 @@
<!-- (C) Copyright IBM Corporation 2001, 2005. All Rights Reserved.
*-->
<task id="changeoil" xml:lang="en-us">
<title>Changing the oil in your car</title>
<shortdesc>Once every 6000 kilometers or three months, change the oil in
your car.</shortdesc>
<title>JavaScript and Chrome Development Tools</title>
<shortdesc>Viewing the Chrone Development console. test</shortdesc>
<taskbody>
<context>
<p>Changing the oil regularly
will help keep the engine in good condition. </p>
<p>Use the Chrome Development console to debug errors that can occur when JavaScript is run. </p>
</context>
<steps>
<stepsection>To change the oil:</stepsection>
<stepsection>To view the console:</stepsection>
<step>
<cmd>Remove the old oil filter.</cmd>
<cmd>Open the Developer Tools and click the Console Tab.</cmd>
</step>
<step>
<cmd>Drain the old oil.</cmd>
<cmd>At the > prompt, enter the JavaScript code to be evaluated.</cmd>
</step>
<step>
<cmd>Install a new oil filter and gasket.</cmd>
<cmd>If the JavaScript code evaluates correctly, you can enter this code into your
script.</cmd>
</step>
<step>
<cmd>Add new oil to the engine.</cmd>
<cmd>If the JavaScript code does not evaluate correctly, determine what is causing the
error. The error could be caused by a typo or misuse of a command.</cmd>
</step>
<step>
<cmd>Check the air filter and replace or clean it.</cmd>
<cmd>Once you have determined the cause of the error, return to step 2.</cmd>
</step>
<step>
<cmd>Top up the windshield washer fluid.</cmd>
<cmd>Continue to debug all errors until there are not any left to debug.</cmd>
</step>
</steps>
</taskbody>
Expand Down