Skip to content

Commit

Permalink
Separate documentation source and output into difference folders
Browse files Browse the repository at this point in the history
  • Loading branch information
@jelovirt
jelovirt committed Apr 25, 2013
0 parents commit e7f0140
Show file tree
Hide file tree
Showing 325 changed files with 17,001 additions and 0 deletions.
60 changes: 60 additions & 0 deletions DITA-OTProjectHome.xml
Original file line number Diff line number Diff line change
@@ -0,0 +1,60 @@
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE topic PUBLIC "-//OASIS//DTD DITA Topic//EN" "topic.dtd">
<topic id="dita-otprojecthome" xml:lang="en-us">
<title>DITA Open Toolkit <keyword keyref="release.version"/></title>
<shortdesc>This document describes the DITA Open Toolkit project—what the project is, and how to
use the site.</shortdesc>
<body>
<section>
<title>What is the DITA Open Toolkit?</title>
<p>The DITA Open Toolkit, or DITA-OT for short, is a set of Java-based, open source tools that
provide processing for DITA maps and topic content. You can download the OT and install it
for free on your computer to get started with topic-based writing and publishing. The
DITA-OT is licensed under the <xref format="html"
href="http://www.opensource.org/licenses/cpl1.0.php" scope="external">CPL 1.0</xref> and
<xref format="html" href="http://www.apache.org/licenses/LICENSE-2.0" scope="external"
>Apache 2.0</xref> open source licenses.</p>
<note>While the DITA Standard itself is owned and developed by OASIS, the DITA Open Toolkit is
an independent, open source implementation of the standard.</note>
<p>Key output formats for the toolkit include:</p>
<ul>
<li>XHTML</li>
<li>PDF (formerly known as PDF2)</li>
<li>ODT (Open Document Format)</li>
<li>Eclipse Help</li>
<li>TocJS (XHTML with a JavaScript frameset)</li>
<li>HTML Help</li>
<li>Java Help</li>
<li>Eclipse Content (normalized DITA plus Eclipse project files)</li>
<li>Word RTF (with some limitations)</li>
<li>Docbook</li>
<li>Troff</li>
</ul>
</section>
<section>
<title>Toolkit documentation</title>
<p>There are two primary sources for documentation about the toolkit.</p><p>Stable
documentation about toolkit usage, parameters, and project management can be found on this
page, using the navigation panel on the left.</p>
<p>New information about the latest toolkit builds, plans for the next release, and other
changing information can be found on the DITA-OT landing page at the dita.xml.org site (link
below). That site also contains the release notes for all upcoming and previous
releases.</p>
</section>
</body>
<related-links>
<linklist>
<title>Shortcuts to important information</title>
<link format="html"
href="http://sourceforge.net/projects/dita-ot/files/DITA-OT%20Stable%20Release/"
scope="external">
<linktext>DITA-OT stable release</linktext>
</link>
<link format="html"
href="http://sourceforge.net/projects/dita-ot/files/DITA-OT%20Latest%20Test%20Build/"
scope="external">
<linktext>DITA-OT latest development build</linktext>
</link>
</linklist>
</related-links>
</topic>
39 changes: 39 additions & 0 deletions admin/BugFixGuidelines-NoCLA.xml
Original file line number Diff line number Diff line change
@@ -0,0 +1,39 @@
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE topic PUBLIC "-//OASIS//DTD DITA Topic//EN"
"topic.dtd">
<topic id="bugfixguidelines" xml:lang="en-us">
<title>Due diligence for submission of bug fixes and patches from
non-committers</title>
<titlealts>
<navtitle>Bug fix guidelines</navtitle>
</titlealts>
<shortdesc>Any organization or individual may submit bug fixes using
a github "pull request", generally tied to a specific report in the
project's issue tracker.</shortdesc>
<body>
<p>Before committing code from a bug fix or patch provided by a third
party who has not signed a current contribution form for the project,
Committers should ask the following questions and follow up as appropriate
in order to ensure that the code can be contributed to the project: </p>
<ul>
<li>What is your name and who is your employer?</li>
<li>Did you write the code that you wish to contribute to the DITA
Open Toolkit project? (If the contributor says no, the code
should not become a “Contribution” to the project. The contributor
may be asked to identify the complete details of the code’s source
and of any licenses or restrictions applicable to the code, but the
work should be conspicuously marked as “Submitted on behalf of a third-party:
[name of contributor]”.)</li>
<li>Do you have the right to grant the copyright and patent licenses
for the contribution that are set forth in the CPL version 1.0 license
and Apache License version 2.0?</li>
<li>Does your employer have any rights to code that you have written,
for example, through your contract for employment? If so, has your
employer given you permission to contribute the code on its behalf
or waived its rights in the code?</li>
<li>Are you aware of any third-party licenses or other restrictions
(such as related patents or trademarks) that could apply to your contribution?
If so, what are they?</li>
</ul>
</body>
</topic>
260 changes: 260 additions & 0 deletions admin/ContributionForm.xml
Original file line number Diff line number Diff line change
@@ -0,0 +1,260 @@
<?xml version="1.0" encoding="UTF-8"?>
<!--Arbortext, Inc., 1988-2011, v.4002-->
<!DOCTYPE topic PUBLIC "-//OASIS//DTD DITA Topic//EN"
"topic.dtd">
<?Pub Sty _display FontColor="red"?>
<topic id="contribution" xml:lang="en-us">
<title>DITA-OT Contribution Questionnaire Form 1.2</title>
<titlealts>
<navtitle>Contribution Questionnaire Form</navtitle>
</titlealts>
<body>
<p>The Contribution Questionnaire is the first step in initiating
the due diligence and approval process by the Project Manager
(PM) for any significant contribution of content to be committed
to the project. Prior to completing this Questionnaire, the
Committer should have technical agreement from the PM that
the new code is required. Once the PM has approved, the Committer,
with the assistance of one or more of the contributors, may
begin the due diligence and approval process by completing
and submitting this questionnaire. </p>
<p> <b>What is meant by a significant contribution?</b> </p>
<p>Any initial code contribution used to kick off a new project. By
definition, this code has been written elsewhere and it needs
to be reviewed. </p>
<p>or </p>
<p>Any contribution authored by someone other than a committer which
is adding new functionality to the codebase. In most cases,
bug fixes do not add new functionality although it&apos;s not
impossible. </p>
<p>or </p>
<p>Any contribution containing third-party code maintained by another
open source project, individual, group, or organization. In
addition to reviewing the contribution, if the license is not
the Common Public License (CPL) or Apache License 2.0, the
PM will need to review and approve the third-party license
for compatibility with the CPL or Apache License 2.0. </p>
<p> <b>How to send PM this form?</b> </p>
<p>Please fill in this form and sign your name and get your employer's
authorized signature, such as your manager's. then send a scanned
copy to Project Manager Robert D Anderson. The scanned copy may be
sent to rdanderson at users.sourceforge.net.</p><?Pub Caret -1?>
<p>NOTE: A questionnaire and approval is not required for bug fixes
or minor enhancements. If you have any questions, please send
an email to the Project Manager.</p>
<p> <b>Your Info</b> </p>
<p>Please provide your contact details:</p>
<simpletable expanse="page" relcolwidth="1* 3*">
<strow>
<stentry>Name:</stentry>
<stentry></stentry>
</strow>
<strow>
<stentry>Organization:</stentry>
<stentry></stentry>
</strow>
<strow>
<stentry>Address:</stentry>
<stentry></stentry>
</strow>
<strow>
<stentry>Phone Number:</stentry>
<stentry></stentry>
</strow>
<strow>
<stentry>E-mail:</stentry>
<stentry></stentry>
</strow>
</simpletable>
<p> <b>Committer</b> </p>
<p>Please provide contact details for the committer who will be
incorporating this contribution into the code base. If this is
the same as above, just put &quot;same&quot; in the Name field.</p>
<simpletable relcolwidth="1* 3*">
<strow>
<stentry>Name:</stentry>
<stentry></stentry>
</strow>
<strow>
<stentry>Organization:</stentry>
<stentry></stentry>
</strow>
<strow>
<stentry>Address:</stentry>
<stentry></stentry>
</strow>
<strow>
<stentry>Phone Number:</stentry>
<stentry></stentry>
</strow>
<strow>
<stentry>E-mail:</stentry>
<stentry></stentry>
</strow>
</simpletable>
<p> <b>PM Approval </b> </p>
<p>PM Approval is required for all significant contributions. Please
provide the contact info of the PM who has given approval for
this contribution:</p>
<simpletable relcolwidth="1* 3*">
<strow>
<stentry>Name:</stentry>
<stentry></stentry>
</strow>
<strow>
<stentry>Phone Number:</stentry>
<stentry></stentry>
</strow>
<strow>
<stentry>E-mail:</stentry>
<stentry></stentry>
</strow>
</simpletable>
<p> <b>Contribution </b> </p>
<p>Please provide details about the contribution:</p>
<simpletable relcolwidth="1* 3*">
<strow>
<stentry>Component/Module (if known): </stentry>
<stentry></stentry>
</strow>
<strow>
<stentry>Contribution Name: </stentry>
<stentry></stentry>
</strow>
<strow>
<stentry>Contribution Version: </stentry>
<stentry></stentry>
</strow>
<strow>
<stentry>Contribution Size (in lines of code): </stentry>
<stentry></stentry>
</strow>
<strow>
<stentry>Contribution Description: </stentry>
<stentry></stentry>
</strow>
<strow>
<stentry>Does this contribution require any packages maintained by
a 3rd party? </stentry>
<stentry></stentry>
</strow>
<strow>
<stentry>Please list all pkgs required by the contribution which are
maintained by a 3rd party: (Please list one package per
line e.g 3rd party package name v1.0) </stentry>
<stentry></stentry>
</strow>
<strow>
<stentry>Supporting Information: </stentry>
<stentry></stentry>
</strow>
<strow>
<stentry>Do you agree to distribute the Contribution under Common
Public License 1.0? </stentry>
<stentry></stentry>
</strow>
<strow>
<stentry>Do you agree to distribute the Contribution under Apache
License 2.0? </stentry>
<stentry></stentry>
</strow>
<strow>
<stentry>Provide any additional information you may have regarding
intellectual property rights (patents, trademarks, etc.)
related to the Contribution. If there is more than one
committer who worked on this contribution, please list
their name and email addresses. </stentry>
<stentry></stentry>
</strow>
</simpletable>
<p> <b>Contributor</b> </p>
<p>Note: All of the contributors should ensure that they possess the
necessary rights to make the contribution under the terms and
conditions set out in the <xref href="ContributionPolicy.xml">Contribution
Policy</xref>.</p>
<p>Please provide contact details for the contributor or the primary
contributor if there is more than one:</p>
<simpletable relcolwidth="1* 3*">
<strow>
<stentry>Name: </stentry>
<stentry></stentry>
</strow>
<strow>
<stentry>Organization: </stentry>
<stentry></stentry>
</strow>
<strow>
<stentry>Phone Number: </stentry>
<stentry></stentry>
</strow>
<strow>
<stentry>E-mail: </stentry>
<stentry></stentry>
</strow>
<strow>
<stentry>% of content authored in the contribution: </stentry>
<stentry></stentry>
</strow>
</simpletable>
<p>If there are other contributors, please provide names, organizations,
e-mail, and percentage of content authored in the contribution:<simpletable
relcolwidth="1* 3*">
<strow>
<stentry>Other Contributors:</stentry>
<stentry></stentry>
</strow>
</simpletable></p>
<p> <b>Cryptography</b> </p>
<p>If the contribution deals in any way with cryptography, please
provide details:</p>
<simpletable relcolwidth="1* 3*">
<strow>
<stentry>Details:</stentry>
<stentry></stentry>
</strow>
<strow>
<stentry>Identify the Cryptography algorithm used: </stentry>
<stentry></stentry>
</strow>
</simpletable>
<p> <b>Contributor's signature</b> </p>
<simpletable relcolwidth="1* 3*">
<strow>
<stentry>Name (Type or Print)</stentry>
<stentry></stentry>
</strow>
<strow>
<stentry>Title</stentry>
<stentry></stentry>
</strow>
<strow>
<stentry>Signature</stentry>
<stentry></stentry>
</strow>
<strow>
<stentry>Date</stentry>
<stentry></stentry>
</strow>
</simpletable>
<p> <b>Contributor employer's signature</b> </p>
<simpletable relcolwidth="1* 3*">
<strow>
<stentry>Name (Type or Print)</stentry>
<stentry></stentry>
</strow>
<strow>
<stentry>Title</stentry>
<stentry></stentry>
</strow>
<strow>
<stentry>Signature</stentry>
<stentry></stentry>
</strow>
<strow>
<stentry>Date</stentry>
<stentry></stentry>
</strow>
</simpletable>
</body>
</topic>
<?Pub *0000007761?>
Loading

0 comments on commit e7f0140

Please sign in to comment.