Franchised restaurants should be located in areas of at least 200 ft2.
7 |
8 |
--------------------------------------------------------------------------------
/CommitteeNote1/resources/committee-note.ditaval:
--------------------------------------------------------------------------------
1 |
2 |
3 |
4 |
5 |
6 | ►
7 | ◄
8 |
9 |
10 |
11 |
--------------------------------------------------------------------------------
/CommitteeNote1/introduction/introduction.ditamap:
--------------------------------------------------------------------------------
1 |
2 |
3 |
11 |
--------------------------------------------------------------------------------
/Spec/components/containers/multimedia-components.dita:
--------------------------------------------------------------------------------
1 |
2 |
3 |
4 | Multimedia components
5 | The multimedia components are used to reference audio or video content.
6 |
7 |
8 |
--------------------------------------------------------------------------------
/Spec/components/examples/lw-body.html:
--------------------------------------------------------------------------------
1 |
2 | An innovative, attractive, and out of the ordinary concept
3 |
4 |
5 |
An innovative, attractive, and out of the ordinary concept
6 |
Are you interested in investing with us? Welcome to our franchise information package.
7 |
8 |
--------------------------------------------------------------------------------
/Spec/components/examples/lw-image.md:
--------------------------------------------------------------------------------
1 | # An innovative, attractive, and out of the ordinary concept
2 |
3 | Are you interested in investing with us? Welcome to our franchise
4 | information package.
5 |
6 | We offer  than 30
7 | exclusive creations for original rolls, from the California roll to
8 | sushi with BBQ chicken or grilled steak.
--------------------------------------------------------------------------------
/Spec/components/examples/lw-multimedia.md:
--------------------------------------------------------------------------------
1 | # Installing and Setting up Remote Lighting
2 |
3 | Installation of your Lighting Kit includes installing the light bulbs into light fixtures, preparing the remote control, and programming lighting groups.
4 |
5 | The following video demonstrates a recommended installation:
6 |
7 |
--------------------------------------------------------------------------------
/Spec/components/examples/lw-pre.html:
--------------------------------------------------------------------------------
1 |
2 | The Sensei Sushi Promise
3 |
4 |
5 |
The Sensei Sushi Promise
6 |
7 | Sensei Sushi cares about tradition
8 | Sensei Sushi cares about the customer
9 | Sensei Sushi cares about fun.
10 |
11 |
12 |
--------------------------------------------------------------------------------
/Spec/architecture/language-terminology.dita:
--------------------------------------------------------------------------------
1 |
2 |
3 |
4 | Language and Terminology
5 | Language and terminology used in this specification.
6 |
7 |
8 |
9 |
10 |
--------------------------------------------------------------------------------
/Spec/components/containers/metadata-components.dita:
--------------------------------------------------------------------------------
1 |
2 |
4 |
5 | Metadata components
6 | Metadata components include data and prolog
7 | components.
8 |
9 |
10 |
--------------------------------------------------------------------------------
/Spec/components/examples/lw-table-dog-breeds.md:
--------------------------------------------------------------------------------
1 | # LwDITA tables
2 |
3 | Dog breeds
4 |
5 | | Dog breed | Size | Life expectancy |
6 | | ----------------- | ------------ | --------------- |
7 | | Australian Shepard | Large | 12-15 years |
8 | | Beagle | Medium | 10-15 years |
9 | | Great Dane | Extra-large | 7-10 years |
10 |
11 |
--------------------------------------------------------------------------------
/Spec/components/containers/basic-topic-components.dita:
--------------------------------------------------------------------------------
1 |
2 |
4 |
5 | Basic topic components
6 | The generic topic structure is used for untyped topics.
7 |
8 |
9 |
10 |
--------------------------------------------------------------------------------
/Spec/components/containers/emphasis-components.dita:
--------------------------------------------------------------------------------
1 |
2 |
3 |
4 | Emphasis components
5 | The emphasis elements are used to emphasize text that is important or serious.
6 |
7 |
8 |
--------------------------------------------------------------------------------
/Spec/architecture/target-audience.dita:
--------------------------------------------------------------------------------
1 |
2 |
3 |
4 | Target Audience and Use Cases
5 | Audiences and use cases that motivated the development of Lightweight DITA
6 |
7 |
8 |
9 |
10 |
--------------------------------------------------------------------------------
/Spec/common/common-examples.dita:
--------------------------------------------------------------------------------
1 |
2 |
3 |
4 | Common examples
5 |
6 |
There is no specific support in the MDITA core
7 | profile. If needed, use an HDITA snippet.
An innovative, attractive, and out of the ordinary concept
6 |
We offer more than 30 exclusive creations of original rolls, from the California roll to sushi with BBQ chicken or grilled steak.
7 |
8 |
--------------------------------------------------------------------------------
/Spec/complex-attributes/complex-attribute-topics.dita:
--------------------------------------------------------------------------------
1 |
2 |
3 |
4 | Complex attribute topics
5 | This is a temporary chapter, used as a placeholder so we can
6 | figure out how certain key references should resolve.
7 |
8 |
--------------------------------------------------------------------------------
/Spec/components/containers/map-components.dita:
--------------------------------------------------------------------------------
1 |
2 |
4 |
5 | Map components
6 | Map components include the core components of LwDITA maps, such
7 | as key definition, key text, and topic reference.
8 |
9 |
10 |
--------------------------------------------------------------------------------
/Spec/components/examples/lw-b.dita:
--------------------------------------------------------------------------------
1 |
2 |
3 |
4 | An innovative, attractive, and out of the ordinary concept
5 |
6 |
We offer more than 30 exclusive creations of original rolls, from sushi with BBQ chicken to grilled steak.
7 | Sensei Sushi cares about tradition
8 | Sensei Sushi cares about the customer
9 | Sensei Sushi cares about fun.
10 |
11 |
12 |
--------------------------------------------------------------------------------
/Spec/components/examples/lw-p.dita:
--------------------------------------------------------------------------------
1 |
2 |
3 |
4 | An innovative, attractive, and out of the ordinary concept
5 |
6 |
We offer more than 30 exclusive creations of original rolls, from the California roll to sushi with BBQ chicken or grilled steak.
7 |
8 |
--------------------------------------------------------------------------------
/Spec/introduction/about-the-lightweight-dita-specification.dita:
--------------------------------------------------------------------------------
1 |
2 |
3 |
4 | About the Lightweight DITA specification
5 | The Lightweight DITA specification includes grammar files and the written
6 | specification.
7 |
8 |
--------------------------------------------------------------------------------
/CommitteeNote1/topics/mdita-core-topic-532.md:
--------------------------------------------------------------------------------
1 | # Installing and Setting up Remote Lighting
2 |
3 | Installation of your lighting kit includes installing the light bulbs into light fixtures, preparing the remote control, and programming lighting groups.
4 |
5 | ## Suggested Steps
6 |
7 | 1. Install light bulbs.
8 | 2. Prepare remote control.
9 | 3. Program lighting groups.
10 |
11 | ## Example
12 |
13 | 
14 |
--------------------------------------------------------------------------------
/CommitteeNote1/elements-and-attributes/lwdita-elements-and-attributes.dita:
--------------------------------------------------------------------------------
1 |
2 |
3 |
4 | LwDITA <ph rev="public-review-1">components</ph>
5 | This section lists the element types and attributes that
6 | are available in LwDITA.
7 |
8 |
--------------------------------------------------------------------------------
/Spec/components/examples/lw-title.dita:
--------------------------------------------------------------------------------
1 |
2 |
3 |
4 | Installing and Setting up Remote Lighting
5 | Installation of your lighting kit includes installing the light bulbs into
6 | light fixtures, preparing the remote control, and programming lighting groups.
7 |
8 |
--------------------------------------------------------------------------------
/Spec/components/examples/lw-topic.dita:
--------------------------------------------------------------------------------
1 |
2 |
3 |
4 | Installing and Setting up Remote Lighting
5 | Installation of your lighting kit includes installing the light bulbs into
6 | light fixtures, preparing the remote control, and programming lighting groups.
7 |
8 |
--------------------------------------------------------------------------------
/Spec/components/examples/lw-audio.html:
--------------------------------------------------------------------------------
1 |
2 | Theme song for our podcast
3 |
4 |
5 |
Theme song for our podcast
6 |
11 |
12 |
--------------------------------------------------------------------------------
/Spec/components/examples/lw-data-prolog.html:
--------------------------------------------------------------------------------
1 |
2 |
3 | An innovative, attractive, and out of the ordinary concept
4 |
5 |
6 |
7 |
8 |
An innovative, attractive, and out of the ordinary concept
9 |
Are you interested in investing with us? Welcome to our franchise information package.
10 |
11 |
--------------------------------------------------------------------------------
/Spec/components/examples/lw-keyref-keytext.dita:
--------------------------------------------------------------------------------
1 |
2 |
3 |
13 |
--------------------------------------------------------------------------------
/Spec/LwDITA-DITA2.0-POC/examples/shortdesc.xdita:
--------------------------------------------------------------------------------
1 |
2 |
3 |
4 | Installing and Setting up Remote Lighting
5 | Installation of your lighting kit includes installing the light bulbs into
6 | light fixtures, preparing the remote control, and programming lighting groups.
7 |
8 |
--------------------------------------------------------------------------------
/CommitteeNote1/xdita/what-is-xdita.dita:
--------------------------------------------------------------------------------
1 |
2 |
3 |
4 | XDITA
5 | XDITA is the authoring format of LwDITA that uses XML to structure information. XDITA is
6 | a subset of DITA, with new multimedia element types added to support interoperability with
7 | HTML5.
8 |
9 |
--------------------------------------------------------------------------------
/Spec/components/examples/lw-data-prolog.dita:
--------------------------------------------------------------------------------
1 |
2 |
3 |
4 | An innovative, attractive, and out of the ordinary concept
5 | Are you interested in investing with us? Welcome to our franchise information package.
6 |
7 |
8 |
9 |
--------------------------------------------------------------------------------
/Spec/components/examples/lw-em.dita:
--------------------------------------------------------------------------------
1 |
2 |
3 |
4 | An innovative, attractive, and out of the ordinary concept
5 |
6 |
We offer more than 30 exclusive creations of original rolls, from the
7 | California roll to sushi with BBQ chicken or grilled steak.
In very rare occasions, our Sensei Sushi kitchen lab technicians can use Sulfuric Acid, FCC (H2SO4) to control pH during processing. Ask your supervisor for more information.
Installation of your lighting kit includes installing the light bulbs into light fixtures, preparing the remote control, and programming lighting groups.
Installation of your lighting kit includes installing the light bulbs into light fixtures, preparing the remote control, and programming lighting groups.
10 |
11 |
12 |
--------------------------------------------------------------------------------
/Spec/components/examples/lw-u.dita:
--------------------------------------------------------------------------------
1 |
2 |
3 |
4 | Installing and Setting up Remote Lighting
5 | Installation of your Remote Lighting Network kit includes installing the light bulbs into
6 | light fixtures, preparing the remote control, and programming lighting groups.
7 |
8 |
--------------------------------------------------------------------------------
/CommitteeNote1/crossformat/crossformat.ditamap:
--------------------------------------------------------------------------------
1 |
2 |
3 |
15 |
--------------------------------------------------------------------------------
/Spec/LwDITA-DITA2.0-POC/examples/shortdesc.hdita:
--------------------------------------------------------------------------------
1 |
2 |
3 |
4 | Installing and Setting up Remote Lighting
5 |
6 |
7 |
8 |
Installing and Setting up Remote Lighting
9 |
Installation of your lighting kit includes installing the light bulbs into light fixtures, preparing the remote control, and programming lighting groups.
10 |
11 |
12 |
--------------------------------------------------------------------------------
/Spec/components/examples/lw-ol.dita:
--------------------------------------------------------------------------------
1 |
2 |
3 |
4 | Make a plan! Start your future today!
5 |
6 |
7 |
Contact one of our franchise advisors
8 |
Pick a location for your restaurant
9 |
Follow our franchise guide
10 |
11 |
12 |
--------------------------------------------------------------------------------
/Spec/base-relationship-tables.ditamap:
--------------------------------------------------------------------------------
1 |
2 |
3 |
17 |
--------------------------------------------------------------------------------
/Spec/components/containers/body-components.dita:
--------------------------------------------------------------------------------
1 |
2 |
4 |
5 | Body components
6 | The body components support the most common types of content
7 | authoring for topics: paragraphs, lists, phrases, figures, and other
8 | common types of exhibits in a document.
9 |
10 |
11 |
12 |
--------------------------------------------------------------------------------
/Spec/components/examples/lw-dl.html:
--------------------------------------------------------------------------------
1 |
2 | Profit, fun, and flavor under the same brand
3 |
4 |
5 |
In very rare occasions, our Sensei Sushi kitchen lab technicians can use Sulfuric Acid, FCC (H2SO4) to control pH during processing. Ask your supervisor for more information.
Installation of your Remote Lighting Network kit includes installing the light bulbs into light fixtures, preparing the remote control, and programming lighting groups.
10 |
11 |
12 |
--------------------------------------------------------------------------------
/Spec/components/containers/related-links-components.dita:
--------------------------------------------------------------------------------
1 |
2 |
4 |
5 | Related links component
6 | The related-links section of LwDITA topics is a special structure
7 | that contains links. Links support navigation from a topic to other
8 | related topics or resources.
9 |
10 |
11 |
--------------------------------------------------------------------------------
/Spec/components/examples/lw-section.html:
--------------------------------------------------------------------------------
1 |
2 | What we offer
3 |
4 |
5 |
What we offer
6 |
We offer warranty of territory exclusivity, initial training, and support through online, email, and telephone channels.
7 |
8 |
Terms and conditions
9 |
Support is reserved for franchises that are without bills past due payment.
Support through online, email, and telephone channels
11 |
12 |
13 |
--------------------------------------------------------------------------------
/org.oasis.xdita/samples/mdita/led-specs.md:
--------------------------------------------------------------------------------
1 | # LED Light Bulb Specifications {#led-specifications}
2 |
3 | Specifications describing the electronics and technology inside the LED light bulb.
4 |
5 | Replacement Lamp Type
6 | : A19
7 |
8 | Voltage
9 | : 120V/60Hz
10 |
11 | Socket
12 | : E26
13 |
14 | Power
15 | : 7.5W (40W Equivalent)
16 |
17 | Power Factor
18 | : >0.7
19 |
20 | Energy
21 | : Energy Star Certified EEL Rating: A|
22 |
23 |
24 |
--------------------------------------------------------------------------------
/Spec/components/examples/lw-ol.html:
--------------------------------------------------------------------------------
1 |
2 | Make a plan! Start your future today!
3 |
4 |
5 |
Make a plan! Start your future today!
6 |
7 |
8 |
Contact one of our franchise advisors
9 |
10 |
11 |
Pick a location for your restaurant
12 |
13 |
14 |
Follow our franchise guide
15 |
16 |
17 |
18 |
--------------------------------------------------------------------------------
/CommitteeNote1/content-model/lwdita-design.dita:
--------------------------------------------------------------------------------
1 |
2 |
3 |
4 | Lightweight DITA design
5 | LwDITA is designed to have a smaller element set, a stricter content model, and fewer
6 | reuse mechanisms than DITA 1.3. However, LwDITA also includes new components that provide increased multimedia support.
8 |
9 |
--------------------------------------------------------------------------------
/Spec/components/examples/lw-strong.dita:
--------------------------------------------------------------------------------
1 |
2 |
3 |
4 | Make a plan! Start your future today!
5 |
6 |
7 |
Contact one of our franchise advisors
8 |
Pick a strategic location for your restaurant
9 |
Follow our franchise guide
10 |
11 |
12 |
13 |
--------------------------------------------------------------------------------
/Spec/components/examples/lw-shortdesc.dita:
--------------------------------------------------------------------------------
1 |
2 |
3 |
4 | Installing and Setting up Remote Lighting
5 | Installation of your lighting kit includes installing the light bulbs into
6 | light fixtures, preparing the remote control, and programming lighting groups.
7 |
8 |
--------------------------------------------------------------------------------
/Spec/components/examples/lw-ph.dita:
--------------------------------------------------------------------------------
1 |
2 |
3 |
4 | What we offer
5 |
6 |
7 |
Know-how license
8 |
Warranty of territory exclusivity
9 |
Initial training
10 |
Support through online, email, and telephone channels
11 |
12 |
13 |
--------------------------------------------------------------------------------
/org.oasis.xdita/samples/mdita/product-specs.md:
--------------------------------------------------------------------------------
1 | # Product Specifications {#product-specs}
2 |
3 | The [product-name] components have specific electronic and technical specifications.
4 |
5 | The components in your lighting network have electronic and technical specifications that are specific to the component type.
6 |
7 | - [Specifications describing the electronics and technology inside the remote control](../xdita/remote-specs.dita).
8 | - [Specifications describing the electronics and technology inside the LED light bulb](led-specs.md).
9 |
--------------------------------------------------------------------------------
/Spec/components/examples/lw-altfig.html:
--------------------------------------------------------------------------------
1 |
2 |
3 |
4 | Home
5 |
6 |
7 |
8 |
Remote Lighting Overview
9 |
The Remote Lighting Network kit includes a wireless smart system that helps make the lighting in your home more energy efficient and easier to manage.
Your operates at a low level of networking power but can successfully connect at long distances because they can send information from light bulb to light bulb.
6 |
7 |
Even in low power networks, be sure to
8 | disconnect all devices before performing maintenance tasks.
9 |
10 |
11 |
12 |
--------------------------------------------------------------------------------
/CommitteeNote1/why-lwdita/why-lwdita.ditamap:
--------------------------------------------------------------------------------
1 |
2 |
3 |
14 |
--------------------------------------------------------------------------------
/Spec/components/examples/lw-image.html:
--------------------------------------------------------------------------------
1 |
2 | An innovative, attractive, and out of the ordinary concept
3 |
4 |
5 |
An innovative, attractive, and out of the ordinary concept
6 |
Are you interested in investing with us? Welcome to our franchise information package.
7 |
We offer than 30 exclusive creations for original rolls, from the California roll to sushi with BBQ chicken or grilled steak.
Installation of your lighting kit includes installing the light bulbs into light fixtures, preparing the remote control, and programming lighting groups.
6 |
13 |
14 |
15 |
16 |
--------------------------------------------------------------------------------
/Spec/LwDITA-DITA2.0-POC/reuse-xref.dita:
--------------------------------------------------------------------------------
1 |
2 |
3 |
4 | <xmlelement>xref</xmlelement>
5 | A cross reference is an inline link. A cross reference can link to a
6 | different location within the current topic, another topic, a specific location in another
7 | topic, or an external resource such as a PDF or Web page.
8 |
9 |
10 |
11 |
12 |
13 |
--------------------------------------------------------------------------------
/Spec/components/examples/lw-note.html:
--------------------------------------------------------------------------------
1 |
2 | Profits, fun, and flavor under the same brand
3 |
4 |
5 |
Profits, fun, and flavor under the same brand
6 |
7 |
Initial investment:
8 |
9 |
$700
10 |
11 |
The initial investment price includes the first franchise fee payment
Support through online, email, and telephone channels
11 |
Access to our knowledge base
12 |
13 |
14 |
--------------------------------------------------------------------------------
/Spec/components/examples/lw-example.md:
--------------------------------------------------------------------------------
1 | # Considerations for planning your lighting network
2 |
3 | Whether you have only one wireless light bulb or you are replacing your entire home with wireless light bulbs, you should plan how you want the lighting on your network to behave with the lighting kit.
4 |
5 | ## Examples {.example}
6 |
7 | - If you only have one light bulb you might want to place it in a central location that would be optimum for turning on and off when you are away or arrive home.
8 |
9 | - If you have multiple light bulbs, you might want to set them up in rooms and lighting groups to be able to better manage them across your home.
10 |
--------------------------------------------------------------------------------
/Spec/components/examples/lw-fn.html:
--------------------------------------------------------------------------------
1 |
2 | Profits, fun, and flavor under the same brand
3 |
4 |
5 |
The initial investment price includes the first franchise fee payment
18 |
19 |
20 |
--------------------------------------------------------------------------------
/Spec/components/examples/lw-image.dita:
--------------------------------------------------------------------------------
1 |
2 |
3 |
4 | An innovative, attractive, and out of the ordinary concept
5 | Are you interested in investing with us? Welcome to our franchise information package.
6 |
7 |
We offer
8 | Icon for a plus sign
9 | than 30 exclusive creations for original rolls, from the California roll to sushi
10 | with BBQ chicken or grilled steak.
The Remote Lighting Network kit includes a wireless smart system that helps make the lighting in your home more energy efficient and easier to manage.
7 |
8 | This image shows the retail package for version 2.3 of the Remote Lighting Network kit and does not represent any other versions
9 | Retail package for the Remote Lighting Network kit
10 |
11 |
12 |
--------------------------------------------------------------------------------
/Spec/components/examples/lw-note.dita:
--------------------------------------------------------------------------------
1 |
2 |
3 |
4 | Profits, fun, and flavor under the same brand
5 |
6 |
7 |
8 |
Initial investment:
9 |
10 |
$700
11 |
12 |
The initial investment price includes the first franchise fee payment
13 |
14 |
15 |
16 |
17 |
Franchise fee:
18 |
$200
19 |
20 |
21 |
22 |
--------------------------------------------------------------------------------
/Spec/components/containers/highlighting-components.dita:
--------------------------------------------------------------------------------
1 |
2 |
3 |
4 | Highlighting components
5 | The highlighting components are used to apply formatting styles to text, such as bold and
6 | italic. Never use these elements when a semantically specific element is available. These
7 | elements are not intended for use by specializers; they are intended solely for use by
8 | authors when no semantically appropriate element is available and a formatting effect is
9 | required.
10 |
11 |
12 |
--------------------------------------------------------------------------------
/CommitteeNote1/topics/xdita-xformat-map-541.ditamap:
--------------------------------------------------------------------------------
1 |
2 |
3 |
--------------------------------------------------------------------------------
/Spec/components/examples/lw-fn.dita:
--------------------------------------------------------------------------------
1 |
2 |
3 |
4 | Profits, fun, and flavor under the same brand
5 |
6 |
7 |
8 |
Initial investment:
9 |
10 |
$700
11 |
12 |
13 |
14 |
Franchise fee:
15 |
$200
16 |
17 |
18 |
19 |
20 |
The initial investment price includes the first franchise fee payment
21 |
22 |
23 |
24 |
25 |
--------------------------------------------------------------------------------
/Spec/architecture/design-principles.dita:
--------------------------------------------------------------------------------
1 |
2 |
3 |
4 | Design Principles
5 | Assumptions, goals, and constraints that influenced the design of Lightweight DITA.
6 |
7 |
8 | Source Format Interoperability
9 |
10 |
11 |
12 | Source Format Equivalence
13 |
14 |
15 |
16 | Source Format Persistence
17 |
18 |
19 |
20 | DITA Compatibility
21 |
22 |
23 |
24 |
25 |
--------------------------------------------------------------------------------
/CommitteeNote1/content-model/new-inline-elements.dita:
--------------------------------------------------------------------------------
1 |
2 |
3 |
4 | Modified footnote element
5 | LwDITA includes a modified element for footnote. It has a required id
6 | attribute to force the use-by-reference model that is available in DITA
7 | 1.3.
8 |
9 |
10 |
The LwDITA footnote element has the following characteristics:
11 |
12 |
Block element
13 |
Available in all block contexts
14 |
Grouped under a dedicated footnotes section
15 |
16 |
17 |
18 |
19 |
20 |
--------------------------------------------------------------------------------
/org.oasis.xdita/plugin.xml:
--------------------------------------------------------------------------------
1 |
2 |
3 |
4 | Lightweight DITA
5 |
6 |
7 |
8 |
9 |
10 |
11 |
12 |
13 |
14 |
15 |
16 |
17 |
20 |
21 |
22 |
23 |
24 |
--------------------------------------------------------------------------------
/CommitteeNote1/topics/mdita-topic-544.md:
--------------------------------------------------------------------------------
1 | ---
2 | id: basic-concepts
3 | ---
4 | You can network LED light bulbs together to operate wirelessly from a remote control
5 | using the RemotaLux app.
6 |
7 | # Basic Concepts of Network Lighting
8 |
9 | Network light bulbs from your [product-name] work with your light fixtures the same way as standard light bulbs. They are different, however, in a couple of ways:
10 |
11 | - The lighting element in the light bulb uses energy-efficient LED technology.
12 | - The light bulb includes wireless technology that allows the light bulb to connect to a network and be managed remotely using the RemotaLux app.
13 |
14 |
Make sure power to the fixture where you are installing the light
15 | bulb is turned OFF.
16 |
17 |
18 |
--------------------------------------------------------------------------------
/CommitteeNote1/content-model/content-model.ditamap:
--------------------------------------------------------------------------------
1 |
2 |
3 |
22 |
--------------------------------------------------------------------------------
/Spec/components/examples/lw-multimedia.dita:
--------------------------------------------------------------------------------
1 |
2 |
3 |
4 | The Sensei Sushi Promise
5 |
6 |
22 |
23 |
24 |
--------------------------------------------------------------------------------
/CommitteeNote1/why-lwdita/development-lwdita-tools.dita:
--------------------------------------------------------------------------------
1 |
2 |
3 |
4 | Development of LwDITA tools and applications
5 | The DITA Technical Committee hopes that LwDITA will make it easier for companies to
6 | develop inexpensive tools for authoring, aggregating, and publishing LwDITA content.
7 |
8 |
DITA 1.3, with its many elements and advanced features, makes it difficult for companies to
9 | implement new authoring and publishing systems. In contrast, the simplified and predictable
10 | structure of LwDITA ought to remove many of the barriers that stand in the way of the development
11 | of new tools, both commercial and open-source.
The OASIS DITA Technical Committee designed LwDITA to be accessible to
10 | the largest possible set of content contributors. Hence, the conformance requirements for
11 | LwDITA authoring applications are intentionally minimally specified, particularly for the
12 | HDITA and MDITA authoring formats. Plain-text editors are considered viable tools for
13 | authoring HDITA and MDITA formats.
14 |
15 |
16 |
17 |
--------------------------------------------------------------------------------
/CommitteeNote1/xdita/xdita-audience.dita:
--------------------------------------------------------------------------------
1 |
2 |
3 |
4 | Audience for XDITA
5 | XDITA is designed for users who want to write DITA content but who do
6 | not want (or need) the full power of DITA.
7 |
8 |
Potential users of XDITA include the following:
9 |
10 |
Information developers who use an XML editor but who want a smaller set of elements and
11 | attributes with which to work
12 |
Departments who want to reduce the cost of developing and maintaining style sheets
13 |
Content developers who want their DITA content to be subsumed by a product documentation set
14 | that is based on Markdown or HTML5
15 |
16 |
17 |
18 |
--------------------------------------------------------------------------------
/CommitteeNote1/mdita/what-is-mdita.dita:
--------------------------------------------------------------------------------
1 |
2 |
3 |
4 | MDITA
5 | MDITA is the authoring format of LwDITA that uses Markdown to structure
6 | information.
7 |
8 |
LwDITA includes two profiles for authoring MDITA topics:
9 |
10 |
11 |
Core profile
12 |
Aligns with the GitHub Flavored Markdown spec and includes markup common to most Markdown flavors.
14 |
15 |
16 |
Extended profile
17 |
Relies upon features only available in specific flavors of Markdown to enable a more consistent DITA-like experience.
18 |
19 |
20 |
21 |
22 |
--------------------------------------------------------------------------------
/CommitteeNote1/why-lwdita/why-go-lightweight.dita:
--------------------------------------------------------------------------------
1 |
2 |
3 |
4 | Why go Lightweight?
5 | Full DITA has more power (and thus complexity) than is needed in some situations. LwDITA
6 | provides a slimmed-down alternative that users can author in the markup flavor of their choice –
7 | XML, Markdown, and HTML5.
8 |
9 |
10 |
Good sentence that I think needs to be relocated elsewhere.
11 |
LwDITA addresses those concerns and shifts with a simplified model that accommodates the needs
12 | of diverse groups of content creators while maintaining cross-format collaboration as a core
13 | design and implementation value.
Whether you have only one wireless light bulb or you are replacing your entire home with wireless light bulbs, you should plan how you want the lighting on your network to behave with the lighting kit.
7 | Examples
8 |
9 |
If you only have one light bulb you might want to place it in a central location that would
10 | be optimum for turning on and off when you are away or arrive home.
11 |
If you have multiple light bulbs, you might want to set them up in rooms and lighting groups to be able to better manage them across your home.
12 |
13 |
14 |
15 |
--------------------------------------------------------------------------------
/CommitteeNote1/mdita/mdita-map-example.dita:
--------------------------------------------------------------------------------
1 |
2 |
3 |
4 | Example of an MDITA map
5 | An MDITA map is authored in Markdown. The following example uses MDITA core-profile syntax to produce a map with a title, and an unordered list (itself containing a nested, unordered list)
6 | of titles for topics and their associated file names.
7 |
8 |
9 |
18 |
19 |
20 |
--------------------------------------------------------------------------------
/CommitteeNote1/topics/hdita-topic-522.html:
--------------------------------------------------------------------------------
1 |
2 |
3 |
4 | Installing and Setting up Remote Lighting
5 |
6 |
7 |
8 |
Installing and Setting up Remote Lighting
9 |
Installation of your lighting kit includes installing the light bulbs into light fixtures, preparing the remote control, and programming lighting groups.
10 |
Steps
11 |
12 |
13 |
Install light bulbs.
14 |
15 |
16 |
Prepare remote control.
17 |
18 |
19 |
Program lighting groups.
20 |
21 |
22 |
Example
23 |
The following video demonstrates a recommended installation:
24 |
25 |
26 |
27 |
28 |
29 |
--------------------------------------------------------------------------------
/org.oasis.xdita/catalog-dita.xml:
--------------------------------------------------------------------------------
1 |
2 |
4 |
5 |
6 |
7 |
8 |
9 |
10 |
11 |
12 |
13 |
14 |
15 |
16 |
17 |
18 |
19 |
--------------------------------------------------------------------------------
/Spec/components/examples/lw-map.dita:
--------------------------------------------------------------------------------
1 |
2 |
3 |
--------------------------------------------------------------------------------
/CommitteeNote1/topics/mdita-extended-topic-532.md:
--------------------------------------------------------------------------------
1 | ---
2 | id: install-and-setup
3 | author: Kevin Lewis
4 | ---
5 | # Installing and Setting up Remote Lighting
6 |
7 | Installation of your Lighting Kit includes installing the light bulbs into light fixtures, preparing the remote control, and programming lighting groups.
8 |
9 | Before you attempt to install your Lighting Kit, please turn off the power in your electrical circuit panel.
10 |
11 | ## Important Terms
12 |
13 | Circuit panel
14 | : Also known as the breaker panel, it represents the main point of distribution circuits in a building.
15 |
16 | Lighting Kit[^1]
17 | : The commercial product covered by this information materials.
18 |
19 | [^1]:
20 | This document occasionally uses the term "lighting kit" (all lowercase letters) for generic statements that do not apply exclusively to your product.
21 |
22 | ## Example
23 |
24 | The following video demonstrates a recommended installation:
25 |
26 |
27 |
--------------------------------------------------------------------------------
/Spec/components/examples/lw-example.html:
--------------------------------------------------------------------------------
1 |
2 |
3 |
4 | Considerations for planning your lighting network
5 |
6 |
7 |
8 |
Considerations for planning your lighting network
9 |
Whether you have only one wireless light bulb or you are replacing your entire home with wireless light bulbs, you should plan how you want the lighting on your network to behave with the lighting kit.
10 |
11 |
Examples
12 |
13 |
If you only have one light bulb you might want to place it in a central location that would
14 | be optimum for turning on and off when you are away or arrive home.
15 |
If you have multiple light bulbs, you might want to set them up in rooms and lighting groups to be able to better manage them across your home.
Before installing your , you should plan how you want your lighting network to behave.
7 |
Whether you have only one wireless light bulb or you are replacing your entire home with wireless light bulbs, you should plan how you want the lighting on your network to behave.
8 |
Example
9 |
10 |
If you only have one light bulb, you might want to place it in a central location that would be optimum for turning on and off when you are away or arrive home.
11 |
If you have multiple light bulbs, you might want to set them up in rooms and lighting groups to be able to better manage them across your home.
12 |
13 |
14 |
15 |
--------------------------------------------------------------------------------
/Spec/LwDITA-DITA2.0-POC/lwdita-poc.ditamap:
--------------------------------------------------------------------------------
1 |
2 |
3 |
28 |
--------------------------------------------------------------------------------
/Spec/authoring-formats/xdita/xdita-introduction.dita:
--------------------------------------------------------------------------------
1 |
2 |
3 |
4 | XDITA
5 | XDITA is the authoring format of LwDITA that uses XML to structure information. XDITA is a subset of DITA, with new multimedia element types added to support interoperability with HTML5.
6 |
7 |
XDITA is designed for users who want to write DITA content but who do not want (or need) the full power of DITA.
8 |
Target users of XDITA include the following:
9 |
10 |
Information developers who use an XML editor but who want a smaller set of elements and
11 | attributes with which to work
12 |
Departments who want to reduce the cost of developing and maintaining style sheets
13 |
Content developers who want their DITA content to be subsumed by a product documentation set
14 | that is based on Markdown or HTML5
15 |
16 |
17 |
18 |
--------------------------------------------------------------------------------
/CommitteeNote1/topics/xdita-topic-512.dita:
--------------------------------------------------------------------------------
1 |
2 |
3 |
4 | Installing and Setting up Remote Lighting
5 | Installation of your lighting kit includes installing the light bulbs into light fixtures, preparing the remote control, and programming lighting groups.
6 |
7 |
8 |
9 |
10 |
11 |
12 | Steps
13 |
14 |
Install light bulbs.
15 |
Prepare remote control.
16 |
Program lighting groups.
17 |
18 |
19 |
20 | Example
21 |
The following video demonstrates a recommended installation:
39 |
40 |
41 |
42 |
43 |
44 |
--------------------------------------------------------------------------------
/CommitteeNote1/content-model/lwdita-map.dita:
--------------------------------------------------------------------------------
1 |
2 |
3 |
4 | LwDITA map
5 | The LwDITA map contains the fundamental structures that are necessary to create a
6 | content collection model and establish relationships among resources.
7 |
8 |
A LwDITA map can contain the following structural elements:
9 |
10 |
11 |
Data
12 |
13 |
14 |
15 |
Map
16 |
A map describes the relationships among a set of resources, such as LwDITA and DITA topics
17 |
18 |
19 |
Navigation title
20 |
21 |
22 |
23 |
Topic metadata
24 |
25 |
26 |
27 |
Topic reference
28 |
29 |
30 |
31 |
A LwDITA map can be represented, with modifications to accommodate different authoring
32 | languages, in XDITA, HDITA, and MDITA.
33 |
34 |
35 |
--------------------------------------------------------------------------------
/CommitteeNote1/hdita/hdita-map-example.dita:
--------------------------------------------------------------------------------
1 |
2 |
3 |
4 | Example of an HDITA map
5 | An HDITA map is authored in HTML5.
6 |
7 |
8 |
9 |
26 |
27 |
28 |
--------------------------------------------------------------------------------
/CommitteeNote1/topics/xdita-map-513.ditamap:
--------------------------------------------------------------------------------
1 |
2 |
3 |
33 |
--------------------------------------------------------------------------------
/CommitteeNote1/content-model/audio-example.dita:
--------------------------------------------------------------------------------
1 |
2 |
3 |
4 | Example of audio element
5 | The following example shows how to use the LwDITA audio element in XDITA and HDITA. In MDITA extended profile, audio is represented using raw HDITA code.
6 |
7 |
8 |
In XDITA, audio is represented as follows:
9 | <p>Once your system is successfully connected to the network, you should hear the following sound:</p>
10 | <audio id="connection">
11 | <controls />
12 | <source value="connection.mp3"/>
13 | </audio>
14 |
15 |
In HDITA (and MDITA extended profile), audio is represented as follows:
16 | <p>Once your system is successfully connected to the network, you should hear the following sound:</p>
17 | <audio id="connection" controls>
18 | <source src="connection.mp3"/>
19 | </audio>
20 |
21 |
22 |
--------------------------------------------------------------------------------
/org.oasis.xdita/samples/remotelighting.ditamap:
--------------------------------------------------------------------------------
1 |
2 |
3 |
28 |
--------------------------------------------------------------------------------
/CommitteeNote1/crossformat/crossformat-examples.dita:
--------------------------------------------------------------------------------
1 |
2 |
3 |
4 | Cross-format example: XDITA map
5 | The following XDITA map links to topics authored in the three formats of LwDITA and DITA
6 | 1.3. It also provides a key for the product name.
7 |
8 |
9 |
28 |
29 |
30 |
31 |
--------------------------------------------------------------------------------
/Spec/complex-attributes/complex-attributes.ditamap:
--------------------------------------------------------------------------------
1 |
2 |
3 |
29 |
--------------------------------------------------------------------------------
/CommitteeNote1/hdita/hdita-audience.dita:
--------------------------------------------------------------------------------
1 |
2 |
3 |
4 | Audience for HDITA
5 | HDITA is designed for users who want to use HTML-authoring tools to write structured content.
6 |
7 |
Potential users of HDITA include the following:
8 |
9 |
Marketing writers who want to contribute to DITA-based product documentation without using an
10 | XML editor
11 |
Software developers who want to contribute to documentation using HTML-authoring tools
12 |
Teachers and trainers who want to create course content for a Web site or learning management
13 | system (LMS)
14 |
Bloggers and content strategists who want to be able to create and edit content using mobile
15 | devices
16 |
Authors who want to write content for the Web that does not require a transformation process
17 |
Non-English-speaking content creators who are comfortable with HTML5 semantic elements
18 |
19 |
20 |
21 |
--------------------------------------------------------------------------------
/CommitteeNote1/crossformat/crossformat-hdita.dita:
--------------------------------------------------------------------------------
1 |
2 |
3 |
4 | Cross-format example: HDITA topic
5 | The following HDITA topic contains a key reference to a product name and a content
6 | reference to a paragraph from an XDITA topic.
7 |
8 |
9 |
10 |
22 |
23 |
24 |
--------------------------------------------------------------------------------
/Spec/conformance/conformance-for-hdita-authoring-applications.dita:
--------------------------------------------------------------------------------
1 |
2 |
3 |
4 | Conformance for HDITA authoring applications
5 |
6 |
7 |
8 |
Text editors are considered viable authoring environments for HDITA. Any can create
9 | valid HTML5.
10 |
Applications that support HDITA authoring MAY:
11 |
Provide guided authoring for HDITA topics, by presenting HDITA components in
12 | valid order and number.
13 |
Support authors in inserting valid HDITA components.
14 |
Limit authors to HDITA components of HTML5, or flag components that, while
15 | valid according to the HTML spec, are not legal in HDITA topics. (must)
16 |
Support authors in authoring HDITA maps to define sets of HDITA topics.
17 |
18 |
19 |
20 |
21 |
--------------------------------------------------------------------------------
/CommitteeNote1/topics/xdita-topic-542.dita:
--------------------------------------------------------------------------------
1 |
2 |
3 |
4 | Programming Light Bulbs to a Lighting Group
5 | You can program one or more light bulbs to a lighting group to operate
6 | that group with your remote control.
7 |
8 |
9 |
Your remote control can manage up to 250 network light bulbs on the same lighting network. When you add a light bulb to the network, you can program it to one or more lighting groups.
10 |
You must assign a light bulb to at least one lighting
11 | group to operate that light bulb.
12 |
13 |
14 |
15 |
16 |
Remove any existing light bulb from the light fixture.
17 |
Install the network light bulb into the light fixture as you would any
18 | standard light bulb.
19 |
Turn power to the light fixture on.
20 |
21 |
22 |
23 |
--------------------------------------------------------------------------------
/CommitteeNote1/content-model/subset-of-elements-in-maps.dita:
--------------------------------------------------------------------------------
1 |
2 |
3 |
4 | <ph rev="public-review-1">Components of</ph> the LwDITA map
5 | LwDITA uses a subset of the map element types that are available in DITA 1.3.
7 |
8 |
The selected subset contains the following map components:
The kit includes a wireless smart lighting system that helps make the lighting in your home more energy efficient and easier to manage. The kit includes the following
8 | components:
9 |
10 |
11 |
Remote Control
12 |
Allows you to power on, power off, and dim groups of lights on your network.
13 |
14 |
15 |
LED Light Bulbs
16 |
Energy-efficient network light bulbs you can install into standard light fixtures.
Electrical hazards can cause burns, shocks and electrocution (death).
25 |
26 |
27 |
28 |
--------------------------------------------------------------------------------
/org.oasis.xdita/samples/xdita/max-number-bulbs.dita:
--------------------------------------------------------------------------------
1 |
2 |
3 |
4 | Maximum Number of Network Light Bulbs
5 | Testing shows you should network no more than 250 light bulbs to maintain reliable performance.
6 |
7 |
There is a limit to the number of light bulbs at which the performance of the begins to decrease. For example, the time it takes a light bulb to respond may start to increase if too many light bulbs are installed on the lighting network. Testing has shown that the lighting network should be limited to a maximum of 250 light bulbs to maintain reliability in performance.
8 |
9 | Example
10 |
The following video demonstrates a recommended installation for a supported number of light bulbs:
Description of this repository is presented in the README file, and guidelines for contribution/participation are given in the CONTRIBUTING file.
8 |
9 |
--------------------------------------------------------------------------------
/Spec/authoring-formats/hdita/hdita-introduction.dita:
--------------------------------------------------------------------------------
1 |
2 |
3 |
4 | HDITA
5 | HDITA is the authoring format of LwDITA that uses HTML5 to structure information. It also uses custom data attributes to provide interoperability with DITA.
6 |
7 |
HDITA is designed for users who want to use HTML-authoring tools to write structured content.
8 |
Target users of HDITA include the following:
9 |
10 |
Marketing writers who want to contribute to DITA-based product documentation without using an
11 | XML editor
12 |
Software developers who want to contribute to documentation using HTML-authoring tools
13 |
Teachers and trainers who want to create course content for a Web site or learning management
14 | system (LMS)
15 |
Bloggers and content strategists who want to be able to create and edit content using mobile
16 | devices
17 |
Authors who want to write content for the Web that does not require a transformation process
18 |
Non-English-speaking content creators who are comfortable with HTML5 semantic elements
19 |
20 |
21 |
22 |
--------------------------------------------------------------------------------
/CommitteeNote1/crossformat/crossformat-mdita.dita:
--------------------------------------------------------------------------------
1 |
2 |
3 |
4 | Cross-format example: MDITA topic
5 | The following MDITA extended-profile topic contains a key reference to a product name
6 | and a content reference to a paragraph from an HDITA topic.
7 |
8 |
9 |
10 |
11 |
29 |
30 |
31 |
--------------------------------------------------------------------------------
/org.oasis.xdita/samples/hdita/intro-network-lighting.html:
--------------------------------------------------------------------------------
1 |
2 |
3 | Basic Concepts of Network Lighting
4 |
5 |
Basic Concepts of Network Lighting
6 |
You can network LED light bulbs together to operate wirelessly from a remote control.
7 |
Network light bulbs work with your light fixtures the same way as standard light bulbs. They are different, however, in a couple of ways:
8 |
9 |
The lighting element in the light bulb uses energy-efficient LED technology.
10 |
The light bulb includes wireless technology that allows the light bulb to connect to a network and be managed remotely.
11 |
12 |
Because the light bulbs can be connected to a network, you have greater flexibility in how you use them.
13 |
Examples
14 |
15 |
You can program your lighting network so that when you press a button upon arriving home, an entryway and a hallway light turn on.
16 |
When you go to bed, your remote control can turn off all lights on the network.
17 |
Network lighting operates at a low level of networking power but can successfully connect at long distances because they can send information from light bulb to light bulb.
18 |
Testing shows you should network no more than 250 light bulbs to maintain reliable performance.
The following example demonstrates the use of definition list entry in an XDITA topic.
38 |
39 |
40 |
41 |
42 |
43 |
--------------------------------------------------------------------------------
/CommitteeNote1/introduction/introduction.dita:
--------------------------------------------------------------------------------
1 |
2 |
3 |
4 | Introduction
5 | Lightweight DITA (LwDITA) is a simplified version of the Darwin Information Typing
6 | Architecture (DITA). In comparison to
7 | DITA 1.3, LwDITA has a smaller element type and attribute set, stricter content models, and a reduced feature set. LwDITA also defines mappings between XML, HTML5, and Markdown, enabling authoring,
8 | collaboration, and publishing across different markup languages.
9 |
10 |
This committee note covers the following points:
11 |
12 |
Rationale for LwDITA
13 |
Design of LwDITA
14 |
Authoring formats in LwDITA
15 |
Potential audiences for LwDITA
16 |
Cross-format authoring and publishing
17 |
Current LwDITA tools
18 |
19 |
20 |
Lightweight DITA is a work in progress. This committee note outlines the current plans in
21 | order to gain design clarity and receive feedback from potential users and implementers. Please
22 | note that details might change between the publication of this committee note and the actual
23 | release of the Lightweight DITA standard.
Applications that support MDITA authoring MAY: in
9 | addition to being an Mdown editor...
10 |
Provide guided authoring for MDITA topics, by presenting MDITA components in
11 | valid order and number.
12 |
Support authors in inserting components from the MDITA extended profile,
13 | where necessary, to use Lightweight DITA features that are not available in
14 | the MDITA core profile.
15 |
Limit authors to components of GitHub Flavored Markdown that are legal in
16 | MDITA core profile topics, or flag components that are not legal in MDITA
17 | topics.
18 |
Support authors in authoring MDITA maps to define sets of MDITA topics.
LED Status Indicators and Group Selection Indicators
46 |
47 |
48 |
49 |
50 |
Lifetime
51 |
52 |
53 |
>18 Months with Alkaline Batteries
54 |
55 |
56 |
57 |
58 |
59 |
60 |
--------------------------------------------------------------------------------
/CommitteeNote1/why-lwdita/simplified-specialization-mechanism.dita:
--------------------------------------------------------------------------------
1 |
2 |
3 |
4 | Simplified specialization mechanism
5 | DITA specialization is a powerful feature that can be intimidating for authors without XML proficiency. LwDITA provides a simplified template-based alternative.
6 |
7 |
The specialization feature of DITA allows for the creation of new element types and attributes that are explicitly and formally derived from existing types. Specialization is probably the main distinguishing feature of DITA. It is a machine-readable extension mechanism that allows great flexibility while still keeping specialized elements and topics as valid DITA. Specialization is a unique DITA feature (unavailable in XML-based structured languages such as DocBook, S1000D, etc.). Nevertheless, many who are now using DITA do not take advantage of specialization. The perceived complexity of specialization is much of the reason for this.
8 |
LwDITA introduces a template-based specialization mechanism that allows authors who are not advanced XML users or do not want to specialize information types following DITA 1.3's recommendations, to create elements and topics unique to their work requirements that would still be compatible with DITA and LwDITA. Using a handful of new LwDITA elements and attributes, authors can generate specialized topic types ready to structure content in XDITA and HDITA (because Markdown has no tags, specialization in MDITA will be limited to a subset of use cases based on HDITA syntax.
The following example demonstrates the use of a cross reference in an MDITA topic.
47 |
48 |
49 |
50 |
51 |
52 |
53 |
54 |
55 |
--------------------------------------------------------------------------------
/CommitteeNote1/crossformat/crossformat.dita:
--------------------------------------------------------------------------------
1 |
2 |
3 |
4 | Authoring cross-format content with LwDITA
5 | LwDITA enables cross-format content sharing. Authors can create topics in XDITA, HDITA, MDITA, or DITA 1.3 and then publish them as a unified collection. With a combination of formats that includes the MDITA extended profile, authors can even use content referencing and key referencing.
6 |
7 |
In the following example, a team that develops content for a lighting product shares topics
8 | authored in the LwDITA authoring formats. The team even takes advantage of the conref/data-conref and keyref/data-keyref
9 | mechanisms. The example contains the following:
10 |
11 |
An XDITA map that references topics authored in XDITA, HDITA, MDITA, and DITA 1.3. It also
12 | contains a key definition for the product name.
13 |
An XDITA topic, created by a technical writer, that reuses content from an MDITA topic
14 |
An HDITA topic, created by a marketing specialist, that reuses content from an XDITA topic
15 |
An extended-profile MDITA topic, created by a software developer, that reuses content from an
16 | HDITA topic
17 |
18 |
Each of the LwDITA topics use a key reference to refer to the product name.
Your operates at a low level of networking power but can successfully connect at long distances because they can send information from light bulb to light bulb.
7 |
The remote control and light bulbs communicate with each other using a low-power wireless networking technology. In this low-power network, the wireless devices are able to interact with each other over the network by sending data from one device to the next, using the best radio signal path on the network. This path does not have to be a direct connection between the remote control and a network light bulb. It can be through any combination of network light bulbs on the low-power network. So, while a network light bulb in a distant room might not be able to communicate directly with the remote control, it can communicate with another nearby network light bulb that will pass the signal across the low-power network until it reaches the remote control.
8 |
9 | Wireless lighting passing information across light bulbs
10 |
11 |
Since wireless devices on a low-power network have built-in antennas for radio communication with other connected devices, they may be prone to the same reception problems that you might have with your mobile phone inside a building. Your remote control can have trouble communicating with the network lighting if their radio signals are blocked by obstacles such as large metal panels or walls containing wire mesh.
The following example demonstrates the use of phrase, via an HDITA snippet, in an MDITA
49 | topic.
50 |
51 |
52 |
53 |
54 |
55 |
56 |
57 |
58 |
--------------------------------------------------------------------------------
/CommitteeNote1/xdita/xdita-map-example.dita:
--------------------------------------------------------------------------------
1 |
2 |
3 |
4 | Example of an XDITA map
5 | The following map is authored in XDITA.
6 |
7 |
8 |
9 |
10 |
43 |
44 |
Note that XDITA requires a navtitle inside a
45 | topicmeta to declare a map's title. This decision eliminates the need
46 | for title as a single-purpose element in maps, and also keeps the
47 | topicmeta options parallel for maps and topics.
The following example demonstrates the use of section in an XDITA topic.
35 |
36 |
37 |
38 |
39 | HDITA example
40 |
The following example demonstrates the use of section in an HDITA topic.
41 |
42 |
43 |
44 |
45 |
46 | MDITA example
47 |
The following example demonstrates the use of section in an MDITA topic.
48 |
49 |
50 |
51 |
52 |
53 |
54 |
55 |
--------------------------------------------------------------------------------
/Spec/introduction/introduction.dita:
--------------------------------------------------------------------------------
1 |
2 |
3 |
4 | Introduction
5 | Lightweight DITA (LwDITA) is a simplified version of the Darwin Information Typing
6 | Architecture (DITA). In comparison to DITA, LwDITA has a smaller component and attribute set,
7 | stricter
8 | content models, and a reduced feature set. LwDITA also defines mappings between XML, HTML5, and
9 | Markdown, enabling authoring, collaboration, and publishing across different markup
10 | languages.
11 |
12 |
The core goals of LwDITA are the following:
13 |
14 |
15 |
Provide a simpler DITA experience
16 |
Provide mappings between XML, HTML5, and Markdown that enable individuals to:
17 |
18 |
Author content in the format of their choice
19 |
Easily exchange and publish content whose source exists in these different markup languages
20 |
21 |
Foster the growth of new, low-cost tools and applications that support LwDITA
22 |
23 |
LwDITA is not a replacement for DITA. Organizations and teams that are already using DITA are
24 | encouraged to explore LwDITA, but they are not the primary audience for this lightweight
25 | standard. Organizations and individuals that have not adopted DITA, either because XML is not a
26 | tool used in their professional communities or they are not familiar with information typing, can
27 | rely on LwDITA as their introduction to structured authoring and content reuse.
The following example demonstrates the use of preformatted text in an MDITA topic.
48 |
49 |
50 |
51 |
52 |
53 |
54 |
55 |
56 |
--------------------------------------------------------------------------------
/Spec/authoring-formats/formats-introduction.dita:
--------------------------------------------------------------------------------
1 |
2 |
3 |
4 | LwDITA authoring formats
5 | Besides the XML structure provided by DITA, LwDITA adds support for structured authoring in HTML5 and Markdown.
6 |
7 |
8 |
9 |
LwDITA has three authoring formats:
10 |
11 |
12 |
XDITA
13 |
An XML-based variant
14 |
15 |
16 |
HDITA
17 |
An HTML5-based variant
18 |
19 |
20 |
MDITA
21 |
A Markdown-based variant
22 |
23 |
24 |
25 |
These authoring formats enable and enhance collaboration across divisional silos. Documents
26 | authored in the various authoring formats can be aggregated and published as a single
27 | document collection. They also can easily integrate into DITA collections.
28 |
The XDITA and HDITA content models are designed to be functionally equivalent to each other, while
29 | MDITA is a compatible subset. XDITA and HDITA conform with the OASIS DITA and W3C HTML5
30 | standards, respectively. In its core profile, MDITA aligns with the GitHub Flavored Markdown
31 | specification. In its extended profile, MDITA can incorporate extensions from PHP Markdown Extra (definition lists and footnotes), Pandoc (YAML front-matter headers) and HDITA
32 | element types and attributes to overcome Markdown limitations as a language for authoring structured
33 | and reusable content.
34 |
35 |
36 |
37 |
38 |
--------------------------------------------------------------------------------
/CommitteeNote1/content-model/subset-of-elements-and-attributes.dita:
--------------------------------------------------------------------------------
1 |
2 |
3 |
4 | <ph rev="public-review-1">Components of</ph> the LwDITA topic
5 | LwDITA uses a subset of the topic element types that are available in DITA 1.3.
7 |
8 |
The subset was carefully chosen to include only the most basic
9 | constructions that are needed to structure information effectively. The Lightweight DITA
10 | subcommittee considered the needs of diverse industries and sectors (including
11 | education, engineering, healthcare, and marketing) when selecting topic elements for
12 | LwDITA.
13 |
The selected subset contains the following document components:
Lists: Definition list, ordered list, unordered list
25 |
Note
26 |
Paragraph
27 |
Phrase
28 |
Prolog
29 |
Preformatted text
30 |
Section
31 |
Short description
32 |
Table
33 |
Title
34 |
Topic
35 |
36 |
37 |
For a complete list of the DITA 1.3 element
38 | types that are included in LwDITA and their availability in the authoring formats,
39 | see .
40 |
41 |
42 |
--------------------------------------------------------------------------------
/Spec/conformance/processing-tool-conformance.dita:
--------------------------------------------------------------------------------
1 |
2 |
3 |
4 | Processing tool conformance
5 | Specifies conformance requirements for tools that process Lightweight DITA content,
6 | typically for publishing or rendering, but possibly for other content-driven
7 | processes.
8 |
9 |
10 |
Processing tools that claim conformance to Lightweight DITA should meet the mandatory and
11 | optional requirements specified here with no, or only trivial, configuration.
12 |
Tools that process Lightweight DITA content MUST:
13 |
Validate XDITA topic and map content, and report XDITA validation errors.
14 |
Follow the Processing Expectations and Rendering Expectations sections of this
15 | specification for each Lightweight DITA component.
16 |
Aggregate topic collections as defined by XDITA, MDITA, and HDITA maps, following the
17 | rules and limitations for each authoring format. Specifically, XDITA maps may aggregate
18 | XDITA, MDITA, and HDITA topics. MDITA maps need only aggregate MDITA topics. HDITA maps
19 | need only aggregate HDITA topics.
20 |
21 |
Tools that process Lightweight DITA MAY:
22 |
Identify and report HDITA and MDITA components that do not comprise legal HDITA or
23 | MDITA content. Cessation of processing is an acceptable response when a processing tool
24 | encounters such content. However, processing tools are encouraged to attempt graceful
25 | degradation on encountering HDITA or MDITA topic or map content that does not conform to
26 | the rules of this specification.
The following example demonstrates the use of a short description in an XDITA topic.
31 |
32 |
33 |
34 |
35 | HDITA example
36 |
The following example demonstrates the use of a short description in an HDITA topic.
37 |
38 |
39 |
40 |
41 |
42 | MDITA example
43 |
The following example demonstrates the use of a short description in an MDITA topic.
44 |
45 |
46 |
47 |
48 |
49 |
50 |
--------------------------------------------------------------------------------
/CommitteeNote1/mdita/mdita-audience.dita:
--------------------------------------------------------------------------------
1 |
2 |
3 |
4 | Audience for MDITA
5 | MDITA is designed for users who want to write structured content with
6 | the minimum of overhead, but who also want to take advantage of the reuse mechanisms associated
7 | with the DITA standard and the multi-channel publishing afforded by standard DITA
8 | tooling.
9 |
10 |
11 |
Potential users of the MDITA core profile include the following:
12 |
13 |
Software developers who want to contribute to DITA-based product documentation without using
14 | an XML editor
15 |
Software developers who want to contribute to product documentation using the tools and
16 | markup of their choice
17 |
Developers and writers in charge of documenting application programming
18 | interfaces (APIs) that need to share content with technical publications
19 |
Individuals authoring content using a platform, such as a mobile device, that does not
20 | support an XML editor
21 |
Individuals authoring content quickly that must be later refactored as structured
22 | content
23 |
Non-English-speaking authors who want to take advantage of DITA reuse and publishing without depending on XML tags written in English
24 |
25 |
Potential users of the MDITA extended profile include the following:
26 |
Content curators who receive occasional contributions from developers written in
27 | Markdown
28 |
Technical editors who need to incorporate Markdown files in DITA or XDITA topic
29 | collections
30 |
Content developers familiar with DITA or XDITA who want to use Markdown as an authoring
31 | language on devices that do not support XML editors
32 |
33 |
34 |
35 |
--------------------------------------------------------------------------------
/CommitteeNote1/content-model/lwdita-topic.dita:
--------------------------------------------------------------------------------
1 |
2 |
3 |
4 | LwDITA topic
5 | The LwDITA topic contains the fundamental structures that are necessary to author a unit
6 | of stand-alone information.
7 |
8 |
A LwDITA topic can contain the following structural elements:
9 |
10 |
11 |
Title
12 |
A label that connotes the purpose of the content that is associated with it.
13 |
14 |
15 |
Short description
16 |
A brief depiction of the purpose or theme of a topic.
17 |
18 |
19 |
20 |
Prolog
21 |
A container for metadata about a topic (for example, author information or subject category).
22 |
23 |
24 |
Body
25 |
A container for the main content of a topic. It might include several sections.
26 |
27 |
28 |
Section
29 |
An organizational division within a topic. It can have an optional title.
30 |
31 |
32 |
33 |
34 |
35 |
A LwDITA topic can be represented, with modifications to accommodate different authoring
36 | languages, in XDITA, HDITA, and MDITA.
The following example demonstrates the use of example in an HDITA
40 | topic.
41 |
42 |
43 |
44 |
45 | MDITA example
46 |
The following example demonstrates the use of example in an MDITA
47 | topic.
48 |
49 |
50 |
51 |
52 |
53 |
54 |
55 |
--------------------------------------------------------------------------------
/CommitteeNote1/xdita/xdita-topic-example.dita:
--------------------------------------------------------------------------------
1 |
2 |
3 |
4 | Example of an XDITA topic
5 | The following topic is authored in XDITA. In addition to basic DITA element types, note
7 | the new video element type.
8 |
9 |
10 |
11 |
12 |
43 |
44 |
XDITA topics are fully compatible with DITA topics. An author can work on an XDITA topic and
45 | keep it in a collection of LwDITA topics, but that same topic will also be compatible with
46 | maps and topics authored in DITA 1.3.
47 |
48 |
49 |
50 |
--------------------------------------------------------------------------------
/CommitteeNote1/content-model/stricter-content-model.dita:
--------------------------------------------------------------------------------
1 |
2 |
3 |
4 | Stricter content model
5 | LwDITA has a much stricter content model than DITA 1.3. This ensures a predictable
6 | markup structure in topics that simplifies reuse, transformations, style sheet logic, and tools
7 | development.
8 |
9 |
This strict content model minimizes authoring decisions by presenting limited choices for
10 | elements and attributes. This model, however, depends on a few strict rules. For example, in
11 | XDITA and HDITA, with a few exceptions, all text must be within paragraph elements. Exceptions
12 | are the description, short description, and title elements. Within paragraphs, the following can
13 | appear:
Note that all text is wrapped in p elements. This restriction of mixed
43 | content in block elements simplifies tool development for processing LwDITA content, and it also
44 | enables easier content reuse, as authors can conref paragraphs from most of
45 | the block contexts that are available in LwDITA.
46 |
47 |
48 |
--------------------------------------------------------------------------------
/Spec/common/lwdita-specification-subjectScheme.ditamap:
--------------------------------------------------------------------------------
1 |
2 |
3 |
4 |
5 |
6 |
7 |
8 |
9 |
10 |
11 |
12 |
13 |
14 |
15 |
16 |
17 |
18 |
19 |
20 |
21 |
22 |
23 |
24 |
25 |
26 |
27 |
28 |
29 |
30 |
31 |
32 |
33 |
34 |
35 |
36 |
37 |
38 |
39 |
40 |
41 |
42 |
43 |
44 |
45 |
46 |
47 |
48 |
49 |
50 |
51 |
52 |
53 |
54 |
55 |
56 |
--------------------------------------------------------------------------------
/CommitteeNote1/acknowledgments/acknowledgments.dita:
--------------------------------------------------------------------------------
1 |
2 |
3 |
4 | Acknowledgments
5 | The following individuals participated in the creation of this document and are
6 | gratefully acknowledged.
7 |
8 |
9 |
10 | Robert D. Anderson, IBM
11 | Jan Benedictus, Fonto Group BV
12 | Deb Bissantz, Vasont Systems
13 | Stan Doherty, Individual member
14 | Kristen James Eberlein, Eberlein Consulting LLC
15 | Carlos Evia, Virginia Tech
16 | Mark Giffin, Individual member
17 | Tim Grantham, Precision Content Authoring Solutions Inc.
18 | Richard Hamilton, Individual member
19 | Nancy Harrison, Individual member
20 | Alan Houser, Individual member
21 | Scott Hudson, The Boeing Company
22 | Ullakaisa Kalander, Citec
23 | Eliot Kimber, Individual member
24 | Tom Magliery, JustSystems Canada
25 | Chris Nitchie, Oberon Technologies
26 | Michael Priestley, IBM
27 | Keith Schengili-Roberts, IXIASOFT
28 | Dawn Stevens, Comtech Services, Inc.
29 | Bob Thomas, Individual member
30 | Leigh White, IXIASOFT
31 |
32 |
33 |
In addition, the OASIS DITA Technical Committee also would like to recognize the following people for their insights and support:
34 |
35 | Jarno Elovirta
36 | Roger Hadley
37 | Kevin John
38 | Kevin Lewis
39 | Scott Prentice
40 | Roger Sheen
41 |
42 |
43 |
44 |
45 |
46 |
--------------------------------------------------------------------------------
/CommitteeNote1/why-lwdita/why-lwdita.dita:
--------------------------------------------------------------------------------
1 |
2 |
3 |
4 | Why Lightweight DITA?
5 | Lightweight DITA is a standards-based alternative for situations in which DITA 1.3 would
6 | be too complex or for communities that do not use XML as an authoring platform.
7 |
8 |
DITA 1.3 is a mature architecture with a deep set of advanced features. This maturity can be
9 | intimidating for those considering adoption, especially for simple scenarios. While simplified
10 | versions of DITA exist, most are vendor-developed and proprietary. A standards-based lightweight
11 | alternative will enable the DITA community to offer a common starting point for simple DITA
12 | scenarios that remains fully compatible with DITA 1.3.
13 |
Some authoring communities have strong ties to specific formats, such as Markdown or HTML. While these formats do
15 | not have the same expressiveness as XML, they bring with them a set of tools and practices that
16 | can be a natural fit with a DITA ecosystem. Lightweight DITA defines a
17 | lower-function level of interchange and mappings for HTML5 and Markdown, thus becoming the first
18 | version of DITA to be truly cross-format —allowing authoring and delivery in a mix of
19 | native formats that are all mapped to a common semantic standard.
20 |
The Lightweight DITA subcommittee began work by identifying key authoring communities that were
21 | interested in the benefits that LwDITA could provide; it then identified scenarios including
22 | cross-format authoring and reuse. LwDITA represents common ground for the functionality that
23 | is needed by the following authoring communities: learning and training, software documentation authored by subject matter experts (SMEs), and marketing
25 | content.
All capitalized terms in the following text have the meanings assigned to them in the OASIS
8 | Intellectual Property Rights Policy (the "OASIS IPR Policy"). The full Policy may be found at the OASIS website.
11 |
This document and translations of it may be copied and furnished to others, and derivative
12 | works that comment on or otherwise explain it or assist in its implementation may be
13 | prepared, copied, published, and distributed, in whole or in part, without restriction of
14 | any kind, provided that the above copyright notice and this section are included on all such
15 | copies and derivative works. However, this document itself may not be modified in any way,
16 | including by removing the copyright notice or references to OASIS, except as needed for the
17 | purpose of developing any document or deliverable produced by an OASIS Technical Committee
18 | (in which case the rules applicable to copyrights, as set forth in the OASIS IPR Policy,
19 | must be followed) or as required to translate it into languages other than English.
20 |
The limited permissions granted above are perpetual and will not be revoked by OASIS or its
21 | successors or assigns.
22 |
This document and the information contained herein is provided on an "AS IS" basis and
23 | OASIS DISCLAIMS ALL WARRANTIES, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO ANY
24 | WARRANTY THAT THE USE OF THE INFORMATION HEREIN WILL NOT INFRINGE ANY OWNERSHIP RIGHTS OR
25 | ANY IMPLIED WARRANTIES OF MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE.
26 |
27 |
28 |
--------------------------------------------------------------------------------
/Spec/common/reuse-topic.dita:
--------------------------------------------------------------------------------
1 |
2 |
3 |
4 | Reuse topic
5 | This topic contains elements that are reused in the LwDITA
6 | spec.
7 |
8 |
9 | Component reference topics
10 |
The syntax for representing this
11 | component varies depending on the authoring format:
12 |
13 |
14 | Template for syntax table
15 |
16 |
17 | Authoring format
18 | Syntax
19 | Example
20 |
21 |
22 | XDITA
23 |
24 |
25 |
26 |
27 |
28 |
29 | HDITA
30 |
31 |
32 |
33 |
34 |
35 |
36 | MDITA
37 |
38 |
39 |
40 |
41 |
42 |
43 |
44 |
45 | Authoring format
46 | Syntax and example
47 |
48 |
49 | XDITA
50 |
51 |
52 |
53 |
54 |
55 |
56 | HDITA
57 |
58 |
59 |
60 |
61 |
62 |
63 | MDITA
64 | There is no specific syntax for description in
65 | MDITA.
66 |
67 |
68 |
69 |
70 |
71 |
--------------------------------------------------------------------------------
/CommitteeNote1/content-model/video-example.dita:
--------------------------------------------------------------------------------
1 |
2 |
3 |
4 | Example of video element
5 | The following example shows how to use the LwDITA video element in XDITA and HDITA. In MDITA extended profile, video is represented using raw HDITA code.
6 |
7 |
8 |
In XDITA, video can be represented as follows:
9 | <p>The following video shows a recommended installation pattern for your lightbulbs:</p>
10 | <video id="pattern" iframe="no">
11 | <controls />
12 | <source value="pattern.mpg"/>
13 | </video>
14 |
In the previous example, the iframe attribute (in bold type) informs processing
15 | agents that this video is a local file and does not need to be embedded in an
16 | iframe. The next example has a video hosted in a service
17 | like YouTube that should be embedded in an iframe.
18 | <p>The following video shows a recommended installation pattern for your lightbulbs:</p>
19 | <video id="pattern" width="320" height="240" iframe="yes">
20 | <controls />
21 | <source value="https://www.youtube.com/embed/5KE8vkg4ijk?html5=1"/>
22 | </video>
23 |
24 |
In HDITA (and MDITA extended profile), video is represented as follows:
25 | <p>The following video shows a recommended installation pattern for your lightbulbs:</p>
26 | <video id="pattern" width="320" height="240 controls">
27 | <source src="pattern.mpg"/>
28 | </video>
29 |
A video hosted in a service like YouTube can be represented in HDITA and MDITA extended profile with the HTML5 iframe element as follows:
12 | 
than 30 exclusive creations for original rolls, from the California roll to sushi with BBQ chicken or grilled steak.