Differences between revisions 5 and 6

Deletions are marked like this. Additions are marked like this.
Line 5: Line 5:
  <title>Web-based Document Structure</title>
  <subtitle>Introduction to Document Assemble</subtitle>
  <para>The microPublishing system uses the <emphasis role="italic">Enterprise Wiki</emphasis>
    web-page functionality - the core technology that powers the Knowledge Center - to organize all
    aspects of document authoring and publishing. </para>
  <para/>
  <para/>
  <para/>
  <bridgehead id="url_functionaltiy" renderas="sect3">Web-page address (URL)
    functionality</bridgehead>
  <para/>
  <title>Introduction to the <emphasis role="italic">micro</emphasis>Publishing System</title>
  <para>The <emphasis role="italic">micro</emphasis>Publishing system brings the process of
    drafting, publishing and maintaining technical reference material into the modern Internet
    world. It combines proven authoring/publishing tools of <emphasis role="italic">structured
      documentation</emphasis> with the web-based collaboration, instant update and search
    technologies.</para>
  <para>WEB AS CENTER OF WORLD</para>
  <bridgehead renderas="sect2">Major Components</bridgehead>
  <para>The microPublishing system is a combination of wiki technology, DocBook markup language and
    XSTL publishing technology. </para>
Line 18: Line 17:
      <para>HTML of document component (simple URL)</para>       <formalpara>
        <title>Enterprise Wiki</title>
        <para>The collaboration tool</para>
      </formalpara>
Line 21: Line 23:
      <para>PDF of document component</para>       <formalpara>
        <title>Structured and Semantic Markup</title>
        <para>A technical markup language that distinguishes the structure and semantic content of a
          document. The focus is to capture the logical structure of the document content. This
          allows the same content to than be published by layout software in many different form,
          ie. web pages, 9" by 7" printed technical books, 8" by 11" PDF, etc,</para>
      </formalpara>
Line 24: Line 32:
      <para>PDF of documet component and all siblings (a chapter with all separate sections)</para>       <formalpara>
        <title>Layout Engine</title>
        <para>Software that takes structured content plus a style sheet and produces the final human
          consumable product. This can be HTML web pages, PDF files, printing press read files for a
          book, speech sythesiser ready file, mobile phone comparable output, etc.</para>
      </formalpara>
    </listitem>
  </itemizedlist>
  <bridgehead renderas="sect3">Enterprise Wiki</bridgehead>
  <para>The wiki technology provides:</para>
  <table frame="all" width="4in">
    <title>Enterprise Wiki Functionality</title>
    <tgroup cols="2" align="left">
      <colspec colname="c1" colnum="1" colwidth="3in"/>
      <colspec colname="c2" colnum="2" colwidth="3in"/>
      <thead>
        <row>
          <entry>Feature</entry>
          <entry>Benefit</entry>
        </row>
      </thead>
      <tbody>
        <row>
          <entry>Document stored on server</entry>
          <entry>Can</entry>
        </row>
        <row>
          <entry>Edit Authorization</entry>
          <entry/>
        </row>
        <row>
          <entry>View Authorization</entry>
          <entry/>
        </row>
        <row>
          <entry>Contributor and date information for each sentence in current document </entry>
          <entry/>
        </row>
        <row>
          <entry>Version History</entry>
          <entry/>
        </row>
      </tbody>
    </tgroup>
  </table>
  <bridgehead renderas="sect3">Structured and Semantic Markup</bridgehead>
  <para>The DocBook markup provides:</para>
  <itemizedlist>
    <listitem>
      <para>Ability to create content with </para>
    </listitem>
  </itemizedlist>
  <table frame="all" width="4in">
    <title>Structured and Semantic Functionality</title>
    <tgroup cols="2" align="left">
      <colspec colname="c1" colnum="1" colwidth="3in"/>
      <colspec colname="c2" colnum="2" colwidth="3in"/>
      <thead>
        <row>
          <entry>Feature</entry>
          <entry>Benefit</entry>
        </row>
      </thead>
      <tbody>
        <row>
          <entry/>
          <entry/>
        </row>
        <row>
          <entry/>
          <entry/>
        </row>
        <row>
          <entry/>
          <entry/>
        </row>
        <row>
          <entry/>
          <entry/>
        </row>
        <row>
          <entry/>
          <entry/>
        </row>
      </tbody>
    </tgroup>
  </table>
  <bridgehead renderas="sect3">Layout Engine</bridgehead>
  <para>The XSTL provides:</para>
  <itemizedlist>
    <listitem>
      <para>Ability to publish in web format and PDF as an automated process after modifications
      </para>
Line 27: Line 127:
      <para>access XML of component</para>
    </listitem>
    <listitem>
      <para>save modified XML for component</para>
    </listitem>
    <listitem>
      <para>access version history for component</para>
    </listitem>
    <listitem>
      <para>access contributor statistics </para>
    </listitem>
    <listitem>
      <para>access current page contributor map</para>
      <para>Ability to craft the look of Web and PDF output from style sheets</para>
Line 42: Line 130:
  <para/>
  <bridgehead id="url_structure" renderas="sect3">URLs define Document Structure</bridgehead>
  <para/>
  <para>This is best explained with an example. In <xref linkend="exPageStructure"/> XXXX ???</para>
  <example id="exPageStructure">
    <title>Page Structure for Simple Book</title>
    <programlisting>.../Book
.../Book/Chapter1
.../Book/Chapter2</programlisting>
  </example>
  <para/>
  <para/>
  <table frame="all" width="4in">
    <title>Layour Engine Functionality</title>
    <tgroup cols="2" align="left">
      <colspec colname="c1" colnum="1" colwidth="3in"/>
      <colspec colname="c2" colnum="2" colwidth="3in"/>
      <thead>
        <row>
          <entry>Feature</entry>
          <entry>Benefit</entry>
        </row>
      </thead>
      <tbody>
        <row>
          <entry/>
          <entry/>
        </row>
        <row>
          <entry/>
          <entry/>
        </row>
        <row>
          <entry/>
          <entry/>
        </row>
        <row>
          <entry/>
          <entry/>
        </row>
        <row>
          <entry/>
          <entry/>
        </row>
      </tbody>
    </tgroup>
  </table>
  <bridgehead id="xslt-processing" renderas="sect3">XSLT Processing - How DocBook markup is turned
    into Published Material</bridgehead>
  <para>Description of publishing process goes here. ???</para>

Chapter 1. Introduction to the microPublishing System

The microPublishing system brings the process of drafting, publishing and maintaining technical reference material into the modern Internet world. It combines proven authoring/publishing tools of structured documentation with the web-based collaboration, instant update and search technologies.

WEB AS CENTER OF WORLD

Major Components

The microPublishing system is a combination of wiki technology, DocBook markup language and XSTL publishing technology.

  • Enterprise Wiki. The collaboration tool

  • Structured and Semantic Markup. A technical markup language that distinguishes the structure and semantic content of a document. The focus is to capture the logical structure of the document content. This allows the same content to than be published by layout software in many different form, ie. web pages, 9" by 7" printed technical books, 8" by 11" PDF, etc,

  • Layout Engine. Software that takes structured content plus a style sheet and produces the final human consumable product. This can be HTML web pages, PDF files, printing press read files for a book, speech sythesiser ready file, mobile phone comparable output, etc.

Enterprise Wiki

The wiki technology provides:

Table 1.1. Enterprise Wiki Functionality

FeatureBenefit
Document stored on serverCan
Edit Authorization 
View Authorization 
Contributor and date information for each sentence in current document  
Version History 

Structured and Semantic Markup

The DocBook markup provides:

  • Ability to create content with

Table 1.2. Structured and Semantic Functionality

FeatureBenefit
  
  
  
  
  

Layout Engine

The XSTL provides:

  • Ability to publish in web format and PDF as an automated process after modifications

  • Ability to craft the look of Web and PDF output from style sheets

Table 1.3. Layour Engine Functionality

FeatureBenefit
  
  
  
  
  

XSLT Processing - How DocBook markup is turned into Published Material

Description of publishing process goes here. ???

Univ/CIE/KA/StrucDoc/HowToBookProto/ChapMicroPub (last edited 2010-02-22 01:32:05 by jeff)