/plugins/XML/tags/release-2-0-7/docs/htmlsidekick.html

# · HTML · 137 lines · 112 code · 25 blank · 0 comment · 0 complexity · a58142316cf0f4b7b386f94148f1bef9 MD5 · raw file 

    

  1. <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0     Transitional//EN" "xhtml1-transitional.dtd">
    2. 

  2. <html>
    3. 

  3.    <head>
    4. 

  4.       <title>HtmlSideKick</title>
    5. 

  5.       <style type="text/css">
    6. 

  6.       .author {
    7. 

  7.             font-weight: strong;
    8. 

  8.             font-size: -1;
    9. 

  9.        };
    10. 

  10.        .smaller {
    11. 

  11.             font-size: -1;
    12. 

  12.        };
    13. 

  13.       </style>      
    14. 

  14.       
    15. 

  15.    </head>
    16. 

  16.        
    17. 

  17.    <body bgcolor="#FFFFFF">
    18. 

  18.     
    19. 

  19.    
    20. 

  20.       <table bgcolor="#CCCCFF" summary="Header"  cellspacing="0" border="0" width="100%" >
    21. 

  21.          <tr>
    22. 

  22.             <td valign="top"><strong><font size="+2">HtmlSideKick</font></strong></td>
    23. 

  23.             <td valign="top" align="right">
    24. 

  24.                <p class="author">Author: Dale Anson </p>                            
    25. 

  25.                <p class="smaller">based on an HTML grammar for javacc by Brian Goetz, Quiotix </p>
    26. 

  26.             </td>
    27. 

  27.          </tr>
    28. 

  28.       </table>
    29. 

  29.       <table summary="Introduction" border="0" cellspacing="0" cellpadding="3" width="100%">
    30. 

  30.          <tr align="center" >
    31. 

  31.             <td bgcolor="#7FB2FF" width="100%">
    32. 

  32.                <strong><font color="#FFFFFF" size="+1"><a name="intro">Introduction</a></font></strong>
    33. 

  33.             </td>
    34. 

  34.          </tr>
    35. 

  35.       </table>
    36. 

  36.       <p>
    37. 

  37.       Suggestions welcome, please contact <tt>jedit-devel@lists.sourceforge.net</tt>. </p>
    38. 

  38. 

  39.       <p>
    40. 

  40.       This plugin parses HTML and JSP files and presents a tree view of the file to aid in navigation. In addition, it provides completion popups for elements, entities and attributes, and automatic insertion or completion of close-tags.  </p>
    41. 

  41. 

  42.       <p>
    43. 

  43.       While designed specifically for HTML and JSP files, this plugin does a pretty good job of displaying ASP, ColdFusion, VRML, PHP, SGML, and Velocity files. Needless to say, it works with XML files too. You can elect to use this plugin for those edit modes by going to Plugins -&gt; Plugin Options... -&gt; SideKick -&gt; Parsers, then selecting "<tt>html</tt>" for those edit modes. </p>
    44. 

  44.       
    45. 

  45.   <h3>Completion</h3>
    46. 

  46. 

  47.   <p>  The HtmlSideKick supports completion for elements and attributes. The completion info provided is not based on the DOCTYPE at the top, but rather based on an HTML "completion info" file which is included with the XML plugin. The DOCTYPE is ignored by the HtmlSideKick.</p>
    48. 

  48.   <p> If you are editing non-XML-compliant HTML, keep in mind that XML plugin provides completion, and does not like attributes unless they are in quotes, so it may pop up completions in inappropriate places if your use of quotes is not XML-compliant. </p>
    49. 

  49. 

  50.   <h3> Validation </h3>
    51. 

  51. 

  52.   <p> HtmlSideKick provides no validation. If you switch to the XML parser, you can get full validation based on any DTD or XML Schema. The "loosest" HTML grammar recognized by the XML parser is this: </p>
    53. 

  53.   
    54. 

  54.   <pre>&lt;!DOCTYPE html PUBLIC &quot;-//W3C//DTD XHTML 1.0 Transitional//EN&quot; &quot;xhtml1-transitional.dtd&quot;&gt;
    55. 

  55.   </pre>
    56. 

  56.   
    57. 

  57. 

  58.       <table summary="Settings" border="0" cellspacing="0" cellpadding="3" width="100%">
    59. 

  59.          <tr align="center">
    60. 

  60.             <td bgcolor="#7FB2FF" width="100%">
    61. 

  61.                <strong><font color="#FFFFFF" size="+1">
    62. 

  62.                <a name="intro"> Settings</a></font></strong>
    63. 

  63.             </td>
    64. 

  64.          </tr>
    65. 

  65.       </table>
    66. 

  66.       <p> This plugin is an extension of both the <a href="jeditresource:/SideKick.jar!/index.html">SideKick</a> and the
    67. 

  67.       <a href="jeditresource:/XML.jar!/index.html">XML</a> plugins. This means that common options for this plugin are specified in the SideKick plugin options. Additional completion options, such as finishing the close-tag when you type <tt>&lt;/</tt>, or providing element/attribute popups based on an XML DTD or schema, are specified in the XML plugin's general options. </p>
    68. 

  68.       
    69. 

  69.       <p>
    70. 

  70.       The settings for HtmlSideKick are found at Plugins -&gt; Plugin Options... -&gt; HtmlSideKick. </p>
    71. 

  71.       <h3>Showing Tag Attributes</h3>
    72. 

  72.       There are 4 settings that affect the display of tag attributes:
    73. 

  73.       <ol>
    74. 

  74.          <li><b>Show Tag Attributes</b> When checked, all non-standard attributes (if any) for the tag will be displayed. </li>
    75. 

  75.          <li><b>Show Core Attributes</b> When checked, the standard core html tag attributes (if any) will be displayed. 
    76. 

  76.          The core attributes are: "id", "class", "style", and "title". </li>
    77. 

  77.          <li><b>Show Language Attributes</b> When checked, the standard attributes (if any) for internationalization will be displayed.
    78. 

  78.          The language attributes are: "lang" and "dir". </li>
    79. 

  79.          <li><b>Show Script Attributes</b> When checked, the standard attributes (if any) for scripting will be displayed.
    80. 

  80.          The scripting attributes are: "onclick", "ondblclick", "onmousedown", "onmouseup", "onmouseover", 
    81. 

  81.          "onmousemove", "onmouseout", "onkeypress", "onkeydown", and "onkeyup". </li>
    82. 

  82.       </ol>
    83. 

  83.       <p>
    84. 

  84.       Regardless of these settings, a full listing of the tag attributes, sorted alphabetically, can be seen by moving the 
    85. 

  85.       mouse pointer over the tag display in the tree.
    86. 

  86.       </p>
    87. 

  87.       
    88. 

  88.       <h3>Showing Brackets</h3>
    89. 

  89.       <p> Display of &lt; and &gt; can be turned on or off by use of the <b>Show tags with &lt; and &gt;</b> checkbox.
    90. 

  90.       </p>
    91. 

  91.       
    92. 

  92.       <h3>Showing Tags</h3>
    93. 

  93.       <p>There are 3 settings that affect the display of tags themselves: </p>
    94. 

  94.       <ol>
    95. 

  95.          <li><b>Show All HTML Tags</b> When selected, all html tags will be displayed. </li>
    96. 

  96.          <li><b>Show Block HTML Tags only</b> When selected, only those html tags that are a "block", that is,
    97. 

  97.          there is both a start tag and an end tag, will be displayed. </li>
    98. 

  98.          <li><b>Show JSP Tags</b> When checked, JSP tags will be displayed. </li>
    99. 

  99.       </ol>
    100. 

  100. 

  101.       <table summary="Future plans" border="0" cellspacing="0" cellpadding="3" width="100%">
    102. 

  102.          <tr align="center">
    103. 

  103.             <td bgcolor="#7FB2FF" width="100%">
    104. 

  104.                <strong><font color="#FFFFFF" size="+1"><a name="future"> Future Plans</a></font></strong>
    105. 

  105.             </td>
    106. 

  106.          </tr>
    107. 

  107.       </table>
    108. 

  108. 

  109.       <ul>
    110. 

  110.       <li> Full W3C validation based on DTD. </li>
    111. 

  111.       </ul>
    112. 

  112.       
    113. 

  113.       <table summary="History" border="0" cellspacing="0" cellpadding="3" width="100%">
    114. 

  114.          <tr align="center" >
    115. 

  115.             <td bgcolor="#7FB2FF" width="100%">
    116. 

  116.                <strong><font color="#FFFFFF" size="+1"><a name="history">History</a></font></strong>
    117. 

  117.             </td>
    118. 

  118.          </tr>
    119. 

  119.       </table>
    120. 

  120. 

  121.       <ul>
    122. 

  122.         <li> 
    123. 

  123.           <b> Version 0.5</b> Merged into XML plugin version 1.1 </li>
    124. 

  124. 

  125.       <li> <b>Version 0.4</b> requires JDK 1.4, jEdit 4.3pre3, SideKick 0.6, XML 0.18, XercesPlugin 2.8 
    126. 

  126.         <ul>
    127. 

  127.         <li> Bugfix release </li>
    128. 

  128.         <li> Extends from XmlParser (in the XML plugin) and now supports element tag, closing, and attribute completions, from HTML and JSP modes. (Alan Ezust). </li>
    129. 

  129.         </ul>
    130. 

  130.     </li>
    131. 

  131.     </ul>
    132. 

  132.    
    133. 

  133.    
    134. 

  134.       
    135. 

  135.    </body>
    136. 

  136. </html>
    137.