PrF UG files export html - Revision history

RichMorin at 00:46, November 14, 2008

2008-11-14T00:46:28Z

RichMorin: /* Output Format */

2008-10-23T10:13:39Z

‎Output Format

RichMorin at 19:50, October 21, 2008

2008-10-21T19:50:49Z

RichMorin at 21:26, October 20, 2008

2008-10-20T21:26:45Z

RichMorin at 21:24, October 20, 2008

2008-10-20T21:24:15Z

RichMorin at 21:23, October 20, 2008

2008-10-20T21:23:48Z

RichMorin at 21:05, October 15, 2008

2008-10-15T21:05:06Z

RichMorin at 22:25, October 14, 2008

2008-10-14T22:25:10Z

RichMorin: Automated import of articles

2008-10-09T08:45:39Z

Automated import of articles

New page

__NOTOC__
== Exporting a Project to HTML ==

{{PrF_UG_TOC_files}}<div id='prf_ug'>

You can generate an HTML view of a project.
This allows you to view all or part of the class hierarchy and,
optionally,
all the instances.
The output consists of an index page,
which gives the class hierarchy for the project,
including links to individual pages for each the class.
Class pages include slot descriptions and optional instances.
If instances are selected,
they have individual pages and appear in the index hierarchy and under each class.

You can generate HTML pages for the entire project,
or restrict the output to a subset of the project.

This topic covers:

<ul class='a'>
<li>
[[#Generating_HTML_Output|Generating HTML Output]]


<li>
[[#Output_Format|Output Format]]


<li>
[[#Output_Options|Configuration Options]]


<ul>
<li>
[[#General_Tab|General Tab]]


<li>
[[#Slots_Tab|Slots Tab]]


<li>
[[#Facets_Tab|Facets Tab]]


<li>
[[#Customization_Tab|Customization Tab]]

</ul>
</ul>

=== Generating HTML Output ===

To generate HTML for a project:

<ol class='a'>
<li>
Select File | Export to Format and select HTML from the submenu.
The Export HTML Configuration Options dialog box will be displayed.

 <div>[[Image:PrF_UG_files_html_general.png|files_html_general]]</div>


<li>
Change your settings,
if desired.
The effect of the different settings is described below. (We recommend changing the output directory;
otherwise,
the files will be saved directly in the {{#var:Pr}} application directory.)


<li>
Click OK.

</ol>

=== Output Format ===

Using the default options produces the following HTML output:

<ul class='a'>
<li>
an index page,
showing the class hierarchy;
the example shown is for a subset of the newspaper project,
with Layout_info selected as the root class

 <div>[[Image:PrF_UG_files_html_news_index.png|files_html_news_index]]</div>


<li>
a page for each class,
showing its superclasses,
subclasses,
slots,
and instances;
the selection of classes is customizable

 <div>[[Image:PrF_UG_files_html_news_sectionclass.png|files_html_news_sectionclass]]</div>


<li>
a page for each slot,
showing its facets and their values;
the list of slots is customizable


<li>
a page for each instance of the chosen classes;
you can choose to omit instances from the HTML web

</ul>

=== Output Options ===

The effect of the different settings is described below.

==== General Tab ====

<ul class='a'>
<li>
Configuration Name:
Allows you to name and save the current settings in the dialog box.
A saved setting is added to the menu;
you can reload it by selecting it from the menu.
To save your settings,
enter a name and then click Save.
This will save the current state of the HTML Export Configuration Options dialog box.
Note that if you do not click Save,
your settings will not be changed.
Also,
if you make additional changes without clicking Save,
they will not be saved.


<li>
Output Directory: (recommended) Allows you to choose a directory where the HTML files will be saved.
By default,
they are saved directly in the {{#var:Pr}} application directory.
You can type a pathname directly in the entry bar or use the button to navigate to the desired directory.


<li>
Root Classes:
Restricts the HTML output to the chosen classes and all their subordinate classes.
By default,
the root class is :THING,
which will generate output for all classes in the hierarchy,
including hidden system classes.
To restrict your view to a smaller section of the project,
first delete the :THING class using the Delete Class button,
then add one or more classes by clicking the Add Class button and selecting the classes you want in the dialog box.
Any class you choose will be included in the tree,
along with all of its subclasses.


<li>
Show Instances:
Select this option to generate a page for each instance subordinate to your chosen root classes.
If you do not wish to include instance pages in your output,
deselect this option.


<li>
Sort Subclasses:
Users can reorder classes manually in the Protege class tree and Protege will remember the order.
To ensure that the project to be exported in alphabetical order,
you'll need to use this option.


<li>
Use numbering for instance lists:
Numbers the instance lists shown for each class.

</ul>

==== Slots Tab ====

This tab allows you to select which slots are displayed.
A selected slot is shown at each class where it occurs and a page is generated for that slot.

<div>[[Image:PrF_UG_files_html_slots.png|files_html_slots]]</div>

==== Facets Tab ====

This tab allows you to select which slot facets are displayed.
A selected facet,
and its value,
is shown for each slot where it appears.

<div>[[Image:PrF_UG_files_html_facets.png|files_html_facets]]</div>

==== Customization Tab ====

This tab allows you to customize the header,
footer,
and stylesheet of the output.
Note that the default style sheet displays the icons for you.

<div>[[Image:PrF_UG_files_html_customization.png|files_html_customization]]</div>

</div>

@@ Line 2: / Line 2: @@
 == Exporting a Project to HTML ==
-{{PrF_UG_TOC_files}}<div id='prf_ug'>
+<noinclude>{{PrF_UG_TOC_files}}<div id='prf_ug'></noinclude>
 You can generate an HTML view of a project.
@@ Line 169: / Line 169: @@
-</div>
+<noinclude></div></noinclude>

@@ Line 53: / Line 53: @@
      </p>
      <div>[[Image:PrF_UG_files_html_news_index.png|frame|none|
-            index page, with Layout info</b> selected]]</div>
+            index page, "Layout_info" selected]]</div>
    <li><p>

@@ Line 167: / Line 167: @@
 <div>[[Image:PrF_UG_files_html_customization.png||frame|none|
         HTML Exports Configuration Options, Customization tab]]</div>
 </div>

@@ Line 147: / Line 147: @@
 and a page is generated for that slot.
-<div>[[Image:PrF_UG_files_html_slots.png|files_html_slots]]</div>
+<div>[[Image:PrF_UG_files_html_slots.png|frame|none|
 ==== Facets Tab ====
@@ Line 156: / Line 157: @@
 <div>[[Image:PrF_UG_files_html_facets.png|frame|none|
-        HTML Exports Configuration Options, Slots tab]]</div>
+        HTML Exports Configuration Options, Facets tab]]</div>
 ==== Customization Tab ====
@@ Line 165: / Line 166: @@
 <div>[[Image:PrF_UG_files_html_customization.png||frame|none|
-        HTML Exports Configuration Options, Facets tab]]</div>
+        HTML Exports Configuration Options, Customization tab]]</div>
 </div>

@@ Line 27: / Line 27: @@
      </p>
      <div>[[Image:PrF_UG_files_html_general.png|frame|none|
-            Export HTML Configuration Options dialog box]]</div>
+            Export HTML Configuration Options dialog box, General tab]]</div>
    <li><p>

@@ Line 26: / Line 26: @@
      The <b>Export HTML Configuration Options</b> dialog box will be displayed.
      </p>
-     <div>[[Image:PrF_UG_files_html_general.png|files_html_general]]</div>
+     <div>[[Image:PrF_UG_files_html_general.png|frame|none|
    <li><p>
@@ Line 51: / Line 52: @@
      with <b>Layout_info</b> selected as the root class
      </p>
-     <div>[[Image:PrF_UG_files_html_news_index.png|files_html_news_index]]</div>
+     <div>[[Image:PrF_UG_files_html_news_index.png|frame|none|
    <li><p>
@@ Line 58: / Line 60: @@
      the selection of classes is customizable
      </p>
-     <div>[[Image:PrF_UG_files_html_news_sectionclass.png|files_html_news_sectionclass]]</div>
+     <div>[[Image:PrF_UG_files_html_news_sectionclass.png|frame|none|
    <li><p>
@@ Line 152: / Line 155: @@
 is shown for each slot where it appears.
-<div>[[Image:PrF_UG_files_html_facets.png|files_html_facets]]</div>
+<div>[[Image:PrF_UG_files_html_facets.png|frame|none|
 ==== Customization Tab ====
@@ Line 160: / Line 164: @@
 Note that the default style sheet displays the icons for you.
-<div>[[Image:PrF_UG_files_html_customization.png|files_html_customization]]</div>
+<div>[[Image:PrF_UG_files_html_customization.png||frame|none|
 </div>

@@ Line 6: / Line 6: @@
 You can generate an HTML view of a project.
 This allows you to view all or part of the class hierarchy and,
-optionally,
+optionally, all the instances.
 The output consists of an <b>index</b> page,
 which gives the class hierarchy for the project,
@@ Line 26: / Line 25: @@
      Select <b>File | Export to Format</b> and select <b>HTML</b> from the submenu.
      The <b>Export HTML Configuration Options</b> dialog box will be displayed.
      </p>
    <li><p>
-     Change your settings,
+     Change your settings, if desired.
-    if desired.
+     The effect of the different settings is described below.
-     The effect of the different settings is described below. (We recommend changing the output directory;
+    (We recommend changing the output directory;
-     otherwise,
+     otherwise, the files will be saved directly
-    the files will be saved directly in the {{#var:Pr}} application directory.)
+    in the {{#var:Pr}} application directory.)
      </p>
@@ Line 49: / Line 47: @@
 <ul class='a'>
    <li><p>
-     an index page,
+     an index page, showing the class hierarchy;
      the example shown is for a subset of the newspaper project,
      with <b>Layout_info</b> selected as the root class
      </p>
    <li><p>
      a page for each class,
-     showing its superclasses,
+     showing its superclasses, subclasses, slots, and instances;
      the selection of classes is customizable
      </p>
    <li><p>
@@ Line 94: / Line 86: @@
      To save your settings,
      enter a name and then click <b>Save</b>.
-     This will save the current state of the <b>HTML Export Configuration Options</b> dialog box.
+     This will save the current state
      Note that if you do not click <b>Save</b>,
      your settings will not be changed.
-     Also,
+     Also, if you make additional changes without clicking <b>Save</b>,
      they will not be saved.
      </p>
    <li><p>
-     <b>Output Directory</b>: (recommended) Allows you to choose a directory where the HTML files will be saved.
+     <b>Output Directory</b>: (recommended)
-     By default,
+    Allows you to choose a directory where the HTML files will be saved.
-    they are saved directly in the {{#var:Pr}} application directory.
+     By default, they are saved directly in the {{#var:Pr}} application directory.
-     You can type a pathname directly in the entry bar or use the button to navigate to the desired directory.
+     You can type a pathname directly in the entry bar
      </p>
@@ Line 112: / Line 105: @@
      <b>Root Classes</b>:
      Restricts the HTML output to the chosen classes and all their subordinate classes.
-     By default,
+     By default, the root class is <b>:THING</b>,
      which will generate output for all classes in the hierarchy,
      including hidden system classes.
      To restrict your view to a smaller section of the project,
      first delete the <b>:THING</b> class using the Delete Class button,
-     then add one or more classes by clicking the Add Class button and selecting the classes you want in the dialog box.
+     then add one or more classes by clicking the Add Class button
      Any class you choose will be included in the tree,
      along with all of its subclasses.
@@ Line 125: / Line 118: @@
    <li><p>
      <b>Show Instances</b>:
-     Select this option to generate a page for each instance subordinate to your chosen root classes.
+     Select this option to generate a page
      If you do not wish to include instance pages in your output,
      deselect this option.
@@ Line 132: / Line 126: @@
    <li><p>
      <b>Sort Subclasses</b>:
-     Users can reorder classes manually in the Protege class tree and Protege will remember the order.
+     Users can reorder classes manually in the Protege class tree
      To ensure that the project to be exported in alphabetical order,
      you'll need to use this option.
@@ Line 146: / Line 141: @@
 This tab allows you to select which slots are displayed.
-A selected slot is shown at each class where it occurs and a page is generated for that slot.
+A selected slot is shown at each class where it occurs
 <div>[[Image:PrF_UG_files_html_slots.png|files_html_slots]]</div>
@@ Line 153: / Line 149: @@
 This tab allows you to select which slot facets are displayed.
-A selected facet,
+A selected facet, and its value,
 is shown for each slot where it appears.
@@ Line 161: / Line 156: @@
 ==== Customization Tab ====
-This tab allows you to customize the header,
+This tab allows you to customize the header, footer,
 and stylesheet of the output.
 Note that the default style sheet displays the icons for you.

@@ Line 17: / Line 17: @@
 You can generate HTML pages for the entire project,
 or restrict the output to a subset of the project.
 === Generating HTML Output ===