bixbite 0.1.0
Sign up to get free protection for your applications and to get access to all the features.
- data/LICENSE +20 -0
- data/README.markdown +49 -0
- data/VERSION +1 -0
- data/bin/bixbite +73 -0
- data/lib/bixbite.rb +13 -0
- data/lib/bixbite/command.rb +14 -0
- data/lib/bixbite/create.rb +76 -0
- data/template/Rakefile +25 -0
- data/template/assets/bixbite/Rakefile.rb +297 -0
- data/template/assets/naturaldocs/NaturalDocs/Config/Languages.txt +286 -0
- data/template/assets/naturaldocs/NaturalDocs/Config/Topics.txt +382 -0
- data/template/assets/naturaldocs/NaturalDocs/Help/customizinglanguages.html +52 -0
- data/template/assets/naturaldocs/NaturalDocs/Help/customizingtopics.html +74 -0
- data/template/assets/naturaldocs/NaturalDocs/Help/documenting.html +58 -0
- data/template/assets/naturaldocs/NaturalDocs/Help/documenting/reference.html +146 -0
- data/template/assets/naturaldocs/NaturalDocs/Help/documenting/walkthrough.html +180 -0
- data/template/assets/naturaldocs/NaturalDocs/Help/example/Default.css +528 -0
- data/template/assets/naturaldocs/NaturalDocs/Help/example/NaturalDocs.js +204 -0
- data/template/assets/naturaldocs/NaturalDocs/Help/examples.css +90 -0
- data/template/assets/naturaldocs/NaturalDocs/Help/images/header/background.png +0 -0
- data/template/assets/naturaldocs/NaturalDocs/Help/images/header/leftside.png +0 -0
- data/template/assets/naturaldocs/NaturalDocs/Help/images/header/logo.png +0 -0
- data/template/assets/naturaldocs/NaturalDocs/Help/images/header/overbody.png +0 -0
- data/template/assets/naturaldocs/NaturalDocs/Help/images/header/overbodybg.png +0 -0
- data/template/assets/naturaldocs/NaturalDocs/Help/images/header/overleftmargin.png +0 -0
- data/template/assets/naturaldocs/NaturalDocs/Help/images/header/overmenu.png +0 -0
- data/template/assets/naturaldocs/NaturalDocs/Help/images/header/overmenubg.png +0 -0
- data/template/assets/naturaldocs/NaturalDocs/Help/images/header/rightside.png +0 -0
- data/template/assets/naturaldocs/NaturalDocs/Help/images/logo.gif +0 -0
- data/template/assets/naturaldocs/NaturalDocs/Help/images/menu/about.png +0 -0
- data/template/assets/naturaldocs/NaturalDocs/Help/images/menu/background.png +0 -0
- data/template/assets/naturaldocs/NaturalDocs/Help/images/menu/bottomleft.png +0 -0
- data/template/assets/naturaldocs/NaturalDocs/Help/images/menu/bottomright.png +0 -0
- data/template/assets/naturaldocs/NaturalDocs/Help/images/menu/community.png +0 -0
- data/template/assets/naturaldocs/NaturalDocs/Help/images/menu/customizing.png +0 -0
- data/template/assets/naturaldocs/NaturalDocs/Help/images/menu/using.png +0 -0
- data/template/assets/naturaldocs/NaturalDocs/Help/index.html +9 -0
- data/template/assets/naturaldocs/NaturalDocs/Help/javascript/BrowserStyles.js +77 -0
- data/template/assets/naturaldocs/NaturalDocs/Help/javascript/PNGHandling.js +72 -0
- data/template/assets/naturaldocs/NaturalDocs/Help/keywords.html +38 -0
- data/template/assets/naturaldocs/NaturalDocs/Help/languages.html +32 -0
- data/template/assets/naturaldocs/NaturalDocs/Help/menu.html +79 -0
- data/template/assets/naturaldocs/NaturalDocs/Help/output.html +84 -0
- data/template/assets/naturaldocs/NaturalDocs/Help/running.html +40 -0
- data/template/assets/naturaldocs/NaturalDocs/Help/styles.css +290 -0
- data/template/assets/naturaldocs/NaturalDocs/Help/styles.html +52 -0
- data/template/assets/naturaldocs/NaturalDocs/Help/troubleshooting.html +18 -0
- data/template/assets/naturaldocs/NaturalDocs/Info/CSSGuide.txt +947 -0
- data/template/assets/naturaldocs/NaturalDocs/Info/File Parsing.txt +83 -0
- data/template/assets/naturaldocs/NaturalDocs/Info/HTMLTestCases.pm +269 -0
- data/template/assets/naturaldocs/NaturalDocs/Info/Languages.txt +107 -0
- data/template/assets/naturaldocs/NaturalDocs/Info/NDMarkup.txt +91 -0
- data/template/assets/naturaldocs/NaturalDocs/Info/Symbol Management.txt +59 -0
- data/template/assets/naturaldocs/NaturalDocs/Info/images/Logo.png +0 -0
- data/template/assets/naturaldocs/NaturalDocs/JavaScript/NaturalDocs.js +836 -0
- data/template/assets/naturaldocs/NaturalDocs/License-GPL.txt +341 -0
- data/template/assets/naturaldocs/NaturalDocs/Modules/NaturalDocs/BinaryFile.pm +294 -0
- data/template/assets/naturaldocs/NaturalDocs/Modules/NaturalDocs/Builder.pm +280 -0
- data/template/assets/naturaldocs/NaturalDocs/Modules/NaturalDocs/Builder/Base.pm +348 -0
- data/template/assets/naturaldocs/NaturalDocs/Modules/NaturalDocs/Builder/FramedHTML.pm +345 -0
- data/template/assets/naturaldocs/NaturalDocs/Modules/NaturalDocs/Builder/HTML.pm +398 -0
- data/template/assets/naturaldocs/NaturalDocs/Modules/NaturalDocs/Builder/HTMLBase.pm +3693 -0
- data/template/assets/naturaldocs/NaturalDocs/Modules/NaturalDocs/ClassHierarchy.pm +860 -0
- data/template/assets/naturaldocs/NaturalDocs/Modules/NaturalDocs/ClassHierarchy/Class.pm +412 -0
- data/template/assets/naturaldocs/NaturalDocs/Modules/NaturalDocs/ClassHierarchy/File.pm +157 -0
- data/template/assets/naturaldocs/NaturalDocs/Modules/NaturalDocs/ConfigFile.pm +497 -0
- data/template/assets/naturaldocs/NaturalDocs/Modules/NaturalDocs/Constants.pm +165 -0
- data/template/assets/naturaldocs/NaturalDocs/Modules/NaturalDocs/DefineMembers.pm +100 -0
- data/template/assets/naturaldocs/NaturalDocs/Modules/NaturalDocs/Error.pm +305 -0
- data/template/assets/naturaldocs/NaturalDocs/Modules/NaturalDocs/File.pm +540 -0
- data/template/assets/naturaldocs/NaturalDocs/Modules/NaturalDocs/ImageReferenceTable.pm +383 -0
- data/template/assets/naturaldocs/NaturalDocs/Modules/NaturalDocs/ImageReferenceTable/Reference.pm +44 -0
- data/template/assets/naturaldocs/NaturalDocs/Modules/NaturalDocs/ImageReferenceTable/String.pm +110 -0
- data/template/assets/naturaldocs/NaturalDocs/Modules/NaturalDocs/Languages.pm +1475 -0
- data/template/assets/naturaldocs/NaturalDocs/Modules/NaturalDocs/Languages/ActionScript.pm +1473 -0
- data/template/assets/naturaldocs/NaturalDocs/Modules/NaturalDocs/Languages/Ada.pm +38 -0
- data/template/assets/naturaldocs/NaturalDocs/Modules/NaturalDocs/Languages/Advanced.pm +828 -0
- data/template/assets/naturaldocs/NaturalDocs/Modules/NaturalDocs/Languages/Advanced/Scope.pm +95 -0
- data/template/assets/naturaldocs/NaturalDocs/Modules/NaturalDocs/Languages/Advanced/ScopeChange.pm +70 -0
- data/template/assets/naturaldocs/NaturalDocs/Modules/NaturalDocs/Languages/Base.pm +832 -0
- data/template/assets/naturaldocs/NaturalDocs/Modules/NaturalDocs/Languages/CSharp.pm +1484 -0
- data/template/assets/naturaldocs/NaturalDocs/Modules/NaturalDocs/Languages/PLSQL.pm +319 -0
- data/template/assets/naturaldocs/NaturalDocs/Modules/NaturalDocs/Languages/Pascal.pm +143 -0
- data/template/assets/naturaldocs/NaturalDocs/Modules/NaturalDocs/Languages/Perl.pm +1370 -0
- data/template/assets/naturaldocs/NaturalDocs/Modules/NaturalDocs/Languages/Prototype.pm +92 -0
- data/template/assets/naturaldocs/NaturalDocs/Modules/NaturalDocs/Languages/Prototype/Parameter.pm +87 -0
- data/template/assets/naturaldocs/NaturalDocs/Modules/NaturalDocs/Languages/Simple.pm +503 -0
- data/template/assets/naturaldocs/NaturalDocs/Modules/NaturalDocs/Languages/Tcl.pm +219 -0
- data/template/assets/naturaldocs/NaturalDocs/Modules/NaturalDocs/Menu.pm +3406 -0
- data/template/assets/naturaldocs/NaturalDocs/Modules/NaturalDocs/Menu/Entry.pm +201 -0
- data/template/assets/naturaldocs/NaturalDocs/Modules/NaturalDocs/NDMarkup.pm +76 -0
- data/template/assets/naturaldocs/NaturalDocs/Modules/NaturalDocs/Parser.pm +1331 -0
- data/template/assets/naturaldocs/NaturalDocs/Modules/NaturalDocs/Parser/JavaDoc.pm +464 -0
- data/template/assets/naturaldocs/NaturalDocs/Modules/NaturalDocs/Parser/Native.pm +1060 -0
- data/template/assets/naturaldocs/NaturalDocs/Modules/NaturalDocs/Parser/ParsedTopic.pm +253 -0
- data/template/assets/naturaldocs/NaturalDocs/Modules/NaturalDocs/Project.pm +1402 -0
- data/template/assets/naturaldocs/NaturalDocs/Modules/NaturalDocs/Project/ImageFile.pm +160 -0
- data/template/assets/naturaldocs/NaturalDocs/Modules/NaturalDocs/Project/SourceFile.pm +113 -0
- data/template/assets/naturaldocs/NaturalDocs/Modules/NaturalDocs/ReferenceString.pm +334 -0
- data/template/assets/naturaldocs/NaturalDocs/Modules/NaturalDocs/Settings.pm +1418 -0
- data/template/assets/naturaldocs/NaturalDocs/Modules/NaturalDocs/Settings/BuildTarget.pm +66 -0
- data/template/assets/naturaldocs/NaturalDocs/Modules/NaturalDocs/SourceDB.pm +678 -0
- data/template/assets/naturaldocs/NaturalDocs/Modules/NaturalDocs/SourceDB/Extension.pm +84 -0
- data/template/assets/naturaldocs/NaturalDocs/Modules/NaturalDocs/SourceDB/File.pm +129 -0
- data/template/assets/naturaldocs/NaturalDocs/Modules/NaturalDocs/SourceDB/Item.pm +201 -0
- data/template/assets/naturaldocs/NaturalDocs/Modules/NaturalDocs/SourceDB/ItemDefinition.pm +45 -0
- data/template/assets/naturaldocs/NaturalDocs/Modules/NaturalDocs/SourceDB/WatchedFileDefinitions.pm +159 -0
- data/template/assets/naturaldocs/NaturalDocs/Modules/NaturalDocs/StatusMessage.pm +102 -0
- data/template/assets/naturaldocs/NaturalDocs/Modules/NaturalDocs/SymbolString.pm +212 -0
- data/template/assets/naturaldocs/NaturalDocs/Modules/NaturalDocs/SymbolTable.pm +1984 -0
- data/template/assets/naturaldocs/NaturalDocs/Modules/NaturalDocs/SymbolTable/File.pm +186 -0
- data/template/assets/naturaldocs/NaturalDocs/Modules/NaturalDocs/SymbolTable/IndexElement.pm +522 -0
- data/template/assets/naturaldocs/NaturalDocs/Modules/NaturalDocs/SymbolTable/Reference.pm +273 -0
- data/template/assets/naturaldocs/NaturalDocs/Modules/NaturalDocs/SymbolTable/ReferenceTarget.pm +97 -0
- data/template/assets/naturaldocs/NaturalDocs/Modules/NaturalDocs/SymbolTable/Symbol.pm +428 -0
- data/template/assets/naturaldocs/NaturalDocs/Modules/NaturalDocs/SymbolTable/SymbolDefinition.pm +96 -0
- data/template/assets/naturaldocs/NaturalDocs/Modules/NaturalDocs/Topics.pm +1319 -0
- data/template/assets/naturaldocs/NaturalDocs/Modules/NaturalDocs/Topics/Type.pm +151 -0
- data/template/assets/naturaldocs/NaturalDocs/Modules/NaturalDocs/Version.pm +384 -0
- data/template/assets/naturaldocs/NaturalDocs/NaturalDocs +400 -0
- data/template/assets/naturaldocs/NaturalDocs/NaturalDocs.bat +17 -0
- data/template/assets/naturaldocs/NaturalDocs/Styles/Default.css +767 -0
- data/template/assets/naturaldocs/NaturalDocs/Styles/Roman.css +765 -0
- data/template/assets/naturaldocs/NaturalDocs/Styles/Small.css +763 -0
- data/template/assets/utilities/pngout +0 -0
- data/template/deploy/public_html/.htaccess +0 -0
- data/template/documentation/js/.htaccess +0 -0
- data/template/src/html/.htaccess +76 -0
- data/template/src/html/css/cmn/global.css +96 -0
- data/template/src/html/css/cmn/ie.css +15 -0
- data/template/src/html/css/cmn/ie6.css +15 -0
- data/template/src/html/images/cmn/.htaccess +0 -0
- data/template/src/html/images/tmp/.htaccess +0 -0
- data/template/src/html/includes/debug.inc +5 -0
- data/template/src/html/includes/footer.inc +52 -0
- data/template/src/html/includes/header.inc +61 -0
- data/template/src/html/includes/html.inc +3 -0
- data/template/src/html/includes/namespace.inc +19 -0
- data/template/src/html/includes/page.inc +151 -0
- data/template/src/html/index.html +35 -0
- data/template/src/html/js/cmn/bootstrap.js +74 -0
- data/template/src/html/js/cmn/global.js +142 -0
- data/template/src/html/js/cmn/lib/LAB.js +348 -0
- data/template/src/html/min/.htaccess +4 -0
- data/template/src/html/min/MinifyCLI.php +19 -0
- data/template/src/html/min/README.txt +132 -0
- data/template/src/html/min/builder/_index.js +242 -0
- data/template/src/html/min/builder/bm.js +36 -0
- data/template/src/html/min/builder/index.php +182 -0
- data/template/src/html/min/builder/ocCheck.php +36 -0
- data/template/src/html/min/builder/rewriteTest.js +1 -0
- data/template/src/html/min/config.php +187 -0
- data/template/src/html/min/groupsConfig.php +34 -0
- data/template/src/html/min/index.php +66 -0
- data/template/src/html/min/lib/FirePHP.php +1370 -0
- data/template/src/html/min/lib/HTTP/ConditionalGet.php +348 -0
- data/template/src/html/min/lib/HTTP/Encoder.php +326 -0
- data/template/src/html/min/lib/JSMin.php +314 -0
- data/template/src/html/min/lib/JSMinPlus.php +1872 -0
- data/template/src/html/min/lib/Minify.php +532 -0
- data/template/src/html/min/lib/Minify/Build.php +103 -0
- data/template/src/html/min/lib/Minify/CSS.php +83 -0
- data/template/src/html/min/lib/Minify/CSS/Compressor.php +250 -0
- data/template/src/html/min/lib/Minify/CSS/UriRewriter.php +270 -0
- data/template/src/html/min/lib/Minify/Cache/APC.php +130 -0
- data/template/src/html/min/lib/Minify/Cache/File.php +125 -0
- data/template/src/html/min/lib/Minify/Cache/Memcache.php +137 -0
- data/template/src/html/min/lib/Minify/ClosureCompiler.php +85 -0
- data/template/src/html/min/lib/Minify/CommentPreserver.php +90 -0
- data/template/src/html/min/lib/Minify/Controller/Base.php +202 -0
- data/template/src/html/min/lib/Minify/Controller/Files.php +78 -0
- data/template/src/html/min/lib/Minify/Controller/Groups.php +94 -0
- data/template/src/html/min/lib/Minify/Controller/MinApp.php +132 -0
- data/template/src/html/min/lib/Minify/Controller/Page.php +82 -0
- data/template/src/html/min/lib/Minify/Controller/Version1.php +118 -0
- data/template/src/html/min/lib/Minify/HTML.php +245 -0
- data/template/src/html/min/lib/Minify/ImportProcessor.php +157 -0
- data/template/src/html/min/lib/Minify/Lines.php +131 -0
- data/template/src/html/min/lib/Minify/Logger.php +45 -0
- data/template/src/html/min/lib/Minify/Packer.php +37 -0
- data/template/src/html/min/lib/Minify/Source.php +187 -0
- data/template/src/html/min/lib/Minify/YUICompressor.php +139 -0
- data/template/src/html/min/lib/Solar/Dir.php +199 -0
- data/template/src/html/min/lib/closure-compiler.jar +0 -0
- data/template/src/html/min/lib/yuicompressor-2.4.2.jar +0 -0
- data/template/src/html/min/utils.php +90 -0
- data/template/src/templates/css/template.css +7 -0
- data/template/src/templates/js/template.js +72 -0
- data/template/src/templates/template.html +18 -0
- data/template/src/yaml/config.yml +46 -0
- data/template/src/yaml/deploy.yml +35 -0
- data/test/bixbite_test.rb +7 -0
- data/test/test_helper.rb +10 -0
- metadata +278 -0
@@ -0,0 +1,52 @@
|
|
1
|
+
|
2
|
+
|
3
|
+
<html><head><title>CSS Styles - Natural Docs</title><link rel=stylesheet type="text/css" href="styles.css"><style type="text/css"><!--
|
4
|
+
|
5
|
+
|
6
|
+
.StyleTable {
|
7
|
+
margin: 1em 5ex 0 5ex }
|
8
|
+
|
9
|
+
.StyleTable td {
|
10
|
+
padding-bottom: .5em}
|
11
|
+
|
12
|
+
.StyleName {
|
13
|
+
font: bold 12pt Georgia, serif;
|
14
|
+
}
|
15
|
+
|
16
|
+
.StyleView,
|
17
|
+
.StyleDownload
|
18
|
+
{
|
19
|
+
padding-left: 3ex;
|
20
|
+
}
|
21
|
+
|
22
|
+
.StyleDescription {
|
23
|
+
width: 100%;
|
24
|
+
padding-left: 3ex }
|
25
|
+
|
26
|
+
.StyleView,
|
27
|
+
.StyleDownload,
|
28
|
+
.StyleDescription {
|
29
|
+
padding-top: 1px;
|
30
|
+
}
|
31
|
+
.IE .StyleView,
|
32
|
+
.IE .StyleDownload,
|
33
|
+
.IE .StyleDescription {
|
34
|
+
padding-top: 0;
|
35
|
+
}
|
36
|
+
|
37
|
+
|
38
|
+
--></style><script language=JavaScript src="javascript/PNGHandling.js"></script><script language=JavaScript src="javascript/BrowserStyles.js"></script></head><body marginwidth=0 marginheight=0 leftmargin=0 topmargin=0><script language=JavaScript><!--
|
39
|
+
OpeningBrowserTags();// --></script>
|
40
|
+
|
41
|
+
<!-- saved from url=(0026)http://www.naturaldocs.org -->
|
42
|
+
|
43
|
+
<table width=100% border=0 cellspacing=0 cellpadding=0><tr><td colspan=3 class=Header><table width=100% border=0 cellspacing=0 cellpadding=0><tr><td><img src="images/header/leftside.png" width=30 height=75><a href="index.html"><img src="images/header/logo.png" width=524 height=75 alt="Natural Docs"></a></td><td align=right><img src="images/header/rightside.png" width=30 height=75></td></tr></table></td></tr><tr><td><img src="images/header/overleftmargin.png" width=10 height=6></td><td class=SideMenuTop><img src="images/header/overmenu.png" width=14 height=6></td><td class=BodyTop><img src="images/header/overbody.png" width=24 height=6></td></tr><tr><td></td><td class=SideMenu nowrap><div class=SideMenuSection><div class=SideMenuTitle><img src="images/menu/about.png" width=52 height=13 alt="About"></div><div class=SideMenuBody><a href="languages.html" class=SideMenuEntry>Language Support</a><a href="output.html" class=SideMenuEntry>Output Formats</a></div></div><div class=SideMenuSection><div class=SideMenuTitle><img src="images/menu/using.png" width=45 height=13 alt="Using"></div><div class=SideMenuBody><a href="documenting.html" class=SideMenuEntry>Documenting<br>Your Code</a><a href="keywords.html" class=SideMenuEntry>Keywords</a><a href="running.html" class=SideMenuEntry>Running</a><a href="troubleshooting.html" class=SideMenuEntry>Troubleshooting</a></div></div><div class=SideMenuSection><div class=SideMenuTitle><img src="images/menu/customizing.png" width=96 height=13 alt="Customizing"></div><div class=SideMenuBody><a href="menu.html" class=SideMenuEntry>Organizing the Menu</a><span class=SideMenuEntry id=SelectedSideMenuEntry>CSS Styles</span><a href="customizingtopics.html" class=SideMenuEntry>Topics and Keywords</a><a href="customizinglanguages.html" class=SideMenuEntry>Languages, Indexes,<br>and Prototypes</a></div></div><div class=SideMenuSection><div class=SideMenuTitle><img src="images/menu/community.png" width=86 height=13 alt="Community"></div><div class=SideMenuBody><a href="http://www.naturaldocs.org/" class=SideMenuEntry>Web Site</a><a href="http://www.naturaldocs.org/mailinglist.html" class=SideMenuEntry>Mailing Lists</a><a href="http://www.naturaldocs.org/messageboards.html" class=SideMenuEntry>Message Boards</a><a href="http://www.naturaldocs.org/bugs.html" class=SideMenuEntry>Bugs and<br>Feature Requests</a></div></div></td><td class=Body width=100%><div class=PageTitle>CSS Styles</div><div class=TOC><a href="#DefaultStyles">Default Styles</a> · <a href="#Customizing">Customizing</a> · <a href="#CommonCustomizations">Common Customizations</a></div><div class=Topic><a name="DefaultStyles"></a><div class=TopicTitle>Default Styles</div><p>These are the styles that come with Natural Docs. They all follow the same color scheme and general layout; the choices are more so that you can choose the style of text you want.</p><p>You choose which style you want for your project by adding “<code>-s <i>[style name]</i></code>” to the command line.</p><table width=100% border=0 cellspacing=0 cellpadding=0 class=StyleTable><tr><td class=StyleName>Default</td><td class=StyleDescription>This is the default style that Natural Docs uses. Most of the text is 10pt Verdana.</td></tr><tr><td class=StyleName>Small</td><td class=StyleDescription>Smaller fonts than Default with most of the text using 8pt Verdana. Some people like the small fonts because you can fit more on the screen at once. However, some people hate them and find them hard to read.</td></tr><tr><td class=StyleName>Roman</td><td class=StyleDescription>Serif fonts with most of the text using 12pt Roman. Some people prefer Roman fonts, usually those that have decent anti-aliasing displays like Mac OS X or Windows XP with ClearType.</td></tr></table></div><div class=Topic><a name="Customizing"></a><div class=TopicTitle>Customizing</div><p>There are two ways to customize the CSS files. One is to build your own file from scratch, and the other is to make a touch-up file that gets applied after one of the default styles. Either way you want to create your own CSS file in your project directory (the one you use with <code>-p</code>) or if you plan on sharing it between many projects, in Natural Docs’ Styles directory.</p><p>To use a custom file, no matter where you put it, you just use it with <code>-s</code> without the CSS extension. So if you made Red.css, you use “<code>-s Red</code>”. If you made a touch-up file instead, you use it after one of the default styles, such as with “<code>-s Default Red</code>”. If you’re so inclined, you can string as many touch-up files together as you want or use one of your own as a base.</p><p>The <a href="http://www.naturaldocs.org/documentation/html/files/Info/CSSGuide-txt.html">CSS Guide</a> documents the page structure and CSS styles of Natural Docs’ output. Always remember to check its <a href="http://www.naturaldocs.org/documentation/html/files/Info/CSSGuide-txt.html#Revisions">revisions section</a> every time you upgrade Natural Docs because it may change between releases.</p></div><div class=Topic><a name="CommonCustomizations"></a><div class=TopicTitle>Common Customizations</div><a name="WebStyleParagraphs"></a><div class="SubTopic First">Web-Style Paragraphs</div><p>Natural Docs defaults to print-style paragraphs like the one you are reading. Each one is indented and there are no blank lines between them. To switch to web-style paragraphs, which have blank lines and no indents, add this to your custom CSS file:</p><pre class=Example>p {
|
44
|
+
text-indent: 0;
|
45
|
+
margin-bottom: 1em;
|
46
|
+
}
|
47
|
+
</pre><a name="PrototypeColors"></a><div class="SubTopic">Prototype Colors</div><p>If you’ve <a href="customizingtopics.html#AddingTopicTypes">added a custom topic type</a> and have it <a href="customizinglanguages.html#Prototypes">finding prototypes for you</a>, you may want to have them appear in a different color than the default black and white. Add this to your custom CSS file:</p><pre class=Example>.C<i>[type]</i> .Prototype {
|
48
|
+
background-color: <i>[color]</i>;
|
49
|
+
border-color: <i>[color]</i>;
|
50
|
+
}
|
51
|
+
</pre><p>Replace <code><i>[type]</i></code> with the name of your topic type, minus any symbols and spaces. So if you added a type “Sound Effect”, you would apply the style to “<code>.CSoundEffect .Prototype</code>”.</p></div></td></tr><tr><td></td><td class=SideMenuBottom><table width=100% border=0 cellspacing=0 cellpadding=0><tr><td class=SideMenuBottomLeft><img src="images/menu/bottomleft.png" width=18 height=19></td><td class=SideMenuBottomRight><img src="images/menu/bottomright.png" width=18 height=19></td></tr></table></td><td class=BodyBottom>Copyright © 2003-2008 Greg Valure</td></tr></table><script language=JavaScript><!--
|
52
|
+
ClosingBrowserTags();// --></script></body></html>
|
@@ -0,0 +1,18 @@
|
|
1
|
+
|
2
|
+
|
3
|
+
<html><head><title>Troubleshooting - Natural Docs</title><link rel=stylesheet type="text/css" href="styles.css"><style type="text/css"><!--
|
4
|
+
|
5
|
+
|
6
|
+
.FAQSummary a:link,
|
7
|
+
.FAQSummary a:visited,
|
8
|
+
.FAQSummary a:hover,
|
9
|
+
.FAQSummary a:active {
|
10
|
+
color: #000000;
|
11
|
+
|
12
|
+
--></style><script language=JavaScript src="javascript/PNGHandling.js"></script><script language=JavaScript src="javascript/BrowserStyles.js"></script></head><body marginwidth=0 marginheight=0 leftmargin=0 topmargin=0><script language=JavaScript><!--
|
13
|
+
OpeningBrowserTags();// --></script>
|
14
|
+
|
15
|
+
<!-- saved from url=(0026)http://www.naturaldocs.org -->
|
16
|
+
|
17
|
+
<table width=100% border=0 cellspacing=0 cellpadding=0><tr><td colspan=3 class=Header><table width=100% border=0 cellspacing=0 cellpadding=0><tr><td><img src="images/header/leftside.png" width=30 height=75><a href="index.html"><img src="images/header/logo.png" width=524 height=75 alt="Natural Docs"></a></td><td align=right><img src="images/header/rightside.png" width=30 height=75></td></tr></table></td></tr><tr><td><img src="images/header/overleftmargin.png" width=10 height=6></td><td class=SideMenuTop><img src="images/header/overmenu.png" width=14 height=6></td><td class=BodyTop><img src="images/header/overbody.png" width=24 height=6></td></tr><tr><td></td><td class=SideMenu nowrap><div class=SideMenuSection><div class=SideMenuTitle><img src="images/menu/about.png" width=52 height=13 alt="About"></div><div class=SideMenuBody><a href="languages.html" class=SideMenuEntry>Language Support</a><a href="output.html" class=SideMenuEntry>Output Formats</a></div></div><div class=SideMenuSection><div class=SideMenuTitle><img src="images/menu/using.png" width=45 height=13 alt="Using"></div><div class=SideMenuBody><a href="documenting.html" class=SideMenuEntry>Documenting<br>Your Code</a><a href="keywords.html" class=SideMenuEntry>Keywords</a><a href="running.html" class=SideMenuEntry>Running</a><span class=SideMenuEntry id=SelectedSideMenuEntry>Troubleshooting</span></div></div><div class=SideMenuSection><div class=SideMenuTitle><img src="images/menu/customizing.png" width=96 height=13 alt="Customizing"></div><div class=SideMenuBody><a href="menu.html" class=SideMenuEntry>Organizing the Menu</a><a href="styles.html" class=SideMenuEntry>CSS Styles</a><a href="customizingtopics.html" class=SideMenuEntry>Topics and Keywords</a><a href="customizinglanguages.html" class=SideMenuEntry>Languages, Indexes,<br>and Prototypes</a></div></div><div class=SideMenuSection><div class=SideMenuTitle><img src="images/menu/community.png" width=86 height=13 alt="Community"></div><div class=SideMenuBody><a href="http://www.naturaldocs.org/" class=SideMenuEntry>Web Site</a><a href="http://www.naturaldocs.org/mailinglist.html" class=SideMenuEntry>Mailing Lists</a><a href="http://www.naturaldocs.org/messageboards.html" class=SideMenuEntry>Message Boards</a><a href="http://www.naturaldocs.org/bugs.html" class=SideMenuEntry>Bugs and<br>Feature Requests</a></div></div></td><td class=Body width=100%><div class=PageTitle>Troubleshooting</div><div class=FAQSummary><div class=FAQSummaryGroup>Natural Docs Issues</div><ul><li><a href="#NoDocs" class=FAQSummaryEntry>I don’t get any documentation.</a></li><li><a href="#MissingTopics" class=FAQSummaryEntry>Some of my topics don’t show up.</a></li><li><a href="#BadFormatting" class=FAQSummaryEntry>Some of my topics aren’t formatting correctly.</a></li><li><a href="#NoPrototypes" class=FAQSummaryEntry>I’m not getting prototypes.</a></li><li><a href="#LinksDontResolve" class=FAQSummaryEntry>My links aren’t working.</a></li></ul><div class=FAQSummaryGroup>Windows Issues</div><ul><li><a href="#CantFindPerl" class=FAQSummaryEntry>I get the message “Bad command or file name” or “perl is not recognized”.</a></li><li><a href="#CantFindND" class=FAQSummaryEntry>I get the message “Can’t open perl script NaturalDocs”.</a></li></ul></div><div class=FAQGroup>Natural Docs Issues</div><div class=FAQEntry><div class=FAQEntryTitle><a name=NoDocs></a>I don’t get any documentation</div><div class="First SubTopic">Is it recognizing your source files?</div><p>If Natural Docs has never said “Parsing <i>n</i> files...” when you run it, or <i>n</i> was way too low a number, it is not finding your source files.</p><p>If it has, try this test. Run Natural Docs once. Edit one of your source files and save it. Run Natural Docs again. If it doesn’t say “Parsing 1 file...” it is not recognizing your file.</p><div class=SubTopic>No, it’s not recognizing them</div><p>The most likely scenario is that Natural Docs doesn’t associate the file extension you’re using with your programming language. Open <code>Languages.txt</code> in Natural Docs’ Config directory and find your language. Underneath it you should see a line that says something like “<code>Extensions: c cpp cxx h hpp hxx</code>”. Add the file extensions you use and try again.</p><p>If you use extensionless or .cgi files, do the same thing but instead look for a line that says something like “<code>Shebang Strings: tclsh wish expect</code>”. If it is not there, you may need to add it yourself. Edit it to include whatever appears in your shebang (<code>#!</code>) line that would say this file belongs to your language.</p><p>Otherwise just make sure you included the directory or one of its parents with <a href="running.html#CommandLine"><code>-i</code> on the command line.</a></p><div class=SubTopic>Yes, it’s recognizing them</div><p>First note that unless you have <a href="languages.html">full language support</a>, Natural Docs will only include <a href="documenting.html">what you write for it.</a> It will not be able to scan your code and pick out all the classes and functions on its own.</p><p>If the problem is with text files, the most likely scenario is that you’re not <a href="documenting/reference.html#TextFiles">including topic lines.</a> Like in comments, only things that appear under “<code>keyword: name</code>” lines count as Natural Docs content.</p><p>If this is happening in code, remember that comments must appear alone on a line. You cannot put Natural Docs comments on the same line as code. This includes having anything appear after a closing block comment symbol.</p></div><div class=FAQEntry><div class=FAQEntryTitle><a name=MissingTopics></a>Some of my topics don’t show up</div><ul><li><a href="keywords.html">Check the list of keywords</a> to see if the one you’re using is there and you spelled it correctly. Note that the web page only has the default set of keywords. You may need to check <code>Topics.txt</code> in Natural Docs’ Config directory and your project directory if you’ve edited them</li><li>If the topics appear in code, make sure that the comments are alone on a line. You cannot put Natural Docs content on the same line as code. This includes having anything appear after a closing block comment symbol.</li><li>Make sure that if you have more than one topic in a comment, there is a blank line above the topic line.</li><li>If you have text boxes or lines, make sure they are completely unbroken. You can also try removing them completely.</li><li>If the topics appear in a text file, make sure you included topic lines. Like in comments, only things that appear after “<code>keyword: name</code>” lines count as Natural Docs content. You could just add a <code>Title:</code> line to the top of the file to fix this.</li></ul></div><div class=FAQEntry><div class=FAQEntryTitle><a name=BadFormatting></a>Some of my topics aren’t formatting correctly</div><ul><li><a href="documenting/reference.html#Headings">Headings</a> must have a blank line above them.</li><li>Lines directly after <a href="documenting/reference.html#BulletLists">bullet</a> or <a href="documenting/reference.html#DefinitionLists">definition</a> lines are part of the previous bullet or definition, even if it’s not indented. Skip a line first to do something else</li><li>If you’re getting symbols scattered throughout your text, make sure any text boxes or lines are completely unbroken. You can also try removing them altogether.</li><li>If your example source code is getting mangled, remember to use the <a href="documenting/reference.html#CodeAndTextDiagrams">example code syntax</a>.</li><li>If a line’s becoming a <a href="documenting/reference.html#Headings">heading</a> but shouldn’t, either get rid of the colon at the end or break it into two lines so the colon appears on the second line</li><li>If a line’s becoming a <a href="documenting/reference.html#DefinitionLists">definition</a> but shouldn’t, either get rid of the space-dash-space (use two dashes or remove one of the spaces) or break it into two lines so that the space-dash-space is on the second line.</li></ul><p>I realize the last two aren’t great. If you have any ideas as to how to reliably detect these kinds of false positives, <a href="#" onClick="location.href='mai' + 'lto:' + 'gregv' + 'alure' + '@' + 'natural' + 'docs.org'; return false;">e-mail me</a>.</p></div><div class=FAQEntry><div class=FAQEntryTitle><a name=NoPrototypes></a>I’m not getting prototypes</div><ul><li>The topic must appear directly above the thing it’s documenting.</li><li>Topics <a href="documenting/reference.html#DefinitionLists">documented in lists</a> will not get prototypes, even if the list break apart in the output.</li><li>The topic name must be present in the prototype somewhere. Make sure the topic title has the same case as in the prototype and that it’s not misspelled. This applies even if your language isn’t case sensitive.</li><li>If you’re documenting something with a new topic type you <a href="customizingtopics.html">added to <code>Topics.txt</code></a>, you must also <a href="customizinglanguages.html#Prototypes">edit <code>Languages.txt</code></a> to tell it how to detect prototypes for that type.</li></ul></div><div class=FAQEntry><div class=FAQEntryTitle><a name=LinksDontResolve></a>My links aren’t working</div><p>If your links appear in the output as “<code><text></code>” instead of being converted to links, do the following:</p><ul><li>Make sure the target appears in the output. The easiest way is to see if it appears in the Everything index.</li><li>Make sure the link is spelled correctly and has the same case as what you’re linking to. This applies even if your language isn’t case sensitive.</li><li>If the topic your link appears in and the link target are not in the same class (or are not both global) make sure you include the class in the link with <code>class.target</code>, <code>class::target</code>, or <code>class->target</code>. You can check which classes topics appear in with the Everything index. If your topics are appearing in the wrong classes, fix the documentation remembering the <a href="documenting/reference.html#KeywordsTopicsAndScope">topic scoping rules</a>.</li></ul></div><div class=FAQGroup>Windows Issues</div><div class=FAQEntry><div class=FAQEntryTitle><a name=CantFindPerl></a>I get the message “Bad command or file name” or “perl is not recognized”</div><p>What’s happening is that NaturalDocs.bat can’t find Perl. You need Perl installed to run Natural Docs, so if you haven’t done so already, you can download and install <a href="http://www.activestate.com/Products/activeperl/">ActiveState’s ActivePerl</a> for free.</p><p>If you already have Perl, it’s bin directory is either not in your path or the path isn’t being used by whatever you’re running it from, which happens on some IDEs. Edit NaturalDocs.bat and on the line that says “<code>perl NaturalDocs %NaturalDocsParams%</code>”, change <code>perl</code> to be the full path to perl.exe, such as <code>“C:\perl\bin\perl.exe”</code>. You need to include the quotes if there are spaces in the path.</p></div><div class=FAQEntry><div class=FAQEntryTitle><a name=CantFindND></a>I get the message “Can’t open perl script NaturalDocs”</div><p>What’s happening is that Perl can’t find the Natural Docs script file. This happens when the working directory or “start in” folder isn’t the directory Natural Docs was installed to. If changing that doesn’t work, or if you don’t have the option to set that, edit NaturalDocs.bat and find the line that says “<code>perl NaturalDocs %NaturalDocsParams%</code>”. Change <code>NaturalDocs</code> to include the full path Natural Docs was installed to, such as <code>“C:\Program Files\Natural Docs\NaturalDocs”</code>. You need to include the quotes if there are spaces in the path.</p></div></td></tr><tr><td></td><td class=SideMenuBottom><table width=100% border=0 cellspacing=0 cellpadding=0><tr><td class=SideMenuBottomLeft><img src="images/menu/bottomleft.png" width=18 height=19></td><td class=SideMenuBottomRight><img src="images/menu/bottomright.png" width=18 height=19></td></tr></table></td><td class=BodyBottom>Copyright © 2003-2008 Greg Valure</td></tr></table><script language=JavaScript><!--
|
18
|
+
ClosingBrowserTags();// --></script></body></html>
|
@@ -0,0 +1,947 @@
|
|
1
|
+
|
2
|
+
Architecture: CSS Structure
|
3
|
+
_______________________________________________________________________________
|
4
|
+
|
5
|
+
It's important to understand the internal HTML file structure and styles in order to design your own CSS style for Natural Docs. If
|
6
|
+
you're content with the default styles, there's no need to read this document.
|
7
|
+
|
8
|
+
Topic: Diagram Conventions
|
9
|
+
|
10
|
+
The diagrams are designed for clarity. In the actual HTML, you'd obviously see "<table class=CDescriptionList></table>"
|
11
|
+
instead of "<table CDescriptionList></table CDescriptionList>".
|
12
|
+
|
13
|
+
- A tag with just a style, for example "CTitle", means an unspecified element with that class. Style with .CTitle.
|
14
|
+
- A tag that includes a #, for example "#Menu", means an unspecified element with that ID. Style with #Menu.
|
15
|
+
- A tag that includes a HTML element as well, for example "table CDescriptionList", means it will always be that element. You
|
16
|
+
can style with either .CDescriptionList or table.CDescriptionList.
|
17
|
+
- A tag that has multiple classes or has an "and" in it, for example "CType and CTopic", means that both styles will apply to the
|
18
|
+
same element. You can style it with .CType.CTopic, noting that the space between them must be omitted.
|
19
|
+
- A tag that has an "or" in it, for example "#Content or #Index", is just shorthand for either of those elements. The diagram
|
20
|
+
applies to both of them but only one will actually appear at a time in the output.
|
21
|
+
- A tag or style with a question mark means that tag or style will only be there in certain situations.
|
22
|
+
|
23
|
+
|
24
|
+
Topic: Page Structure
|
25
|
+
_______________________________________________________________________________
|
26
|
+
|
27
|
+
The body tag is used to distinguish between the types of pages.
|
28
|
+
|
29
|
+
Unframed Content/Index Page:
|
30
|
+
|
31
|
+
(start diagram)
|
32
|
+
|
33
|
+
<body ContentPage or IndexPage)>
|
34
|
+
[browser styles]
|
35
|
+
|
36
|
+
<#Content or #Index>
|
37
|
+
Content or Index
|
38
|
+
</#Content or #Index>
|
39
|
+
|
40
|
+
<#Menu>
|
41
|
+
Menu
|
42
|
+
</#Menu>
|
43
|
+
|
44
|
+
<#Footer>
|
45
|
+
Footer
|
46
|
+
</#Footer>
|
47
|
+
|
48
|
+
[/browser styles]
|
49
|
+
</body ContentPage or IndexPage)>
|
50
|
+
|
51
|
+
(end diagram)
|
52
|
+
|
53
|
+
|
54
|
+
Unframed Search Results Popup Page:
|
55
|
+
|
56
|
+
(start diagram)
|
57
|
+
|
58
|
+
<body PopupSearchResultsPage>
|
59
|
+
[browser styles]
|
60
|
+
|
61
|
+
<#Index>
|
62
|
+
Index
|
63
|
+
</#Index>
|
64
|
+
|
65
|
+
[browser styles]
|
66
|
+
</body PopupSearchResultsPage>
|
67
|
+
|
68
|
+
(end diagram)
|
69
|
+
|
70
|
+
|
71
|
+
Framed Menu Page:
|
72
|
+
|
73
|
+
(start diagram)
|
74
|
+
|
75
|
+
<body FramedMenuPage>
|
76
|
+
[browser styles]
|
77
|
+
|
78
|
+
<#Menu>
|
79
|
+
Menu
|
80
|
+
</#Menu>
|
81
|
+
|
82
|
+
<#Footer>
|
83
|
+
Footer
|
84
|
+
</#Footer>
|
85
|
+
|
86
|
+
[browser styles]
|
87
|
+
</body FramedMenuPage>
|
88
|
+
|
89
|
+
(end diagram)
|
90
|
+
|
91
|
+
|
92
|
+
Framed Content/Index/SearchResults Page:
|
93
|
+
|
94
|
+
(start diagram)
|
95
|
+
|
96
|
+
<body FramedContentPage or FramedIndexPage or FramedSearchResultsPage>
|
97
|
+
[browser styles]
|
98
|
+
|
99
|
+
<#Content or #Index>
|
100
|
+
Content or Index
|
101
|
+
</#Content or #Index>
|
102
|
+
|
103
|
+
[browser styles]
|
104
|
+
</body FramedContentPage or FramedIndexPage or FramedSearchResultsPage>
|
105
|
+
|
106
|
+
(end diagram)
|
107
|
+
|
108
|
+
|
109
|
+
Styles: Page Styles
|
110
|
+
|
111
|
+
ContentPage - An unframed content page.
|
112
|
+
IndexPage - An unframed index page.
|
113
|
+
PopupSearchResultsPage - A search results page for use in a popup iframe.
|
114
|
+
|
115
|
+
FramedContentPage - A framed content page.
|
116
|
+
FramedIndexPage - A framed index page.
|
117
|
+
FramedSearchResultsPage - A framed search results page.
|
118
|
+
|
119
|
+
#Footer - The page footer. Will be in a framed menu page or on its own in a non-framed page.
|
120
|
+
|
121
|
+
See Also:
|
122
|
+
|
123
|
+
- <#Content>
|
124
|
+
- <#Menu>
|
125
|
+
- <#Index>
|
126
|
+
- <#Footer>
|
127
|
+
|
128
|
+
|
129
|
+
|
130
|
+
|
131
|
+
Styles: Browser Styles
|
132
|
+
_______________________________________________________________________________
|
133
|
+
|
134
|
+
|
135
|
+
Natural Docs pages include JavaScript to detect which browser the user is running and apply styles so that you can work
|
136
|
+
around browser quirks right in the CSS file.
|
137
|
+
|
138
|
+
The browser type and version styles will be applied immediately after the body tag. However, neither are guaranteed to be
|
139
|
+
there; the user may have JavaScript turned off or be using a browser that isn't detected. These styles should only be used to
|
140
|
+
correct minor flaws and should not be heavily relied on.
|
141
|
+
|
142
|
+
> <body>
|
143
|
+
> <browser type>?
|
144
|
+
> <browser version>?
|
145
|
+
>
|
146
|
+
> Page Content
|
147
|
+
>
|
148
|
+
> <browser version>?
|
149
|
+
> <browser type>?
|
150
|
+
> </body>
|
151
|
+
|
152
|
+
For example, if a <CTopic>'s style is giving you problems in Internet Explorer 6, override it with .IE6 .CTopic. If a <MTitle>'s
|
153
|
+
style gives you a problem in Opera 7 but only in frames, override it with .Framed.Opera7 .MTitle.
|
154
|
+
|
155
|
+
Browser Types:
|
156
|
+
|
157
|
+
If the browser is not one of the types below, neither this nor the browser version will be present. There's the possibility that
|
158
|
+
some obscure browser will appear as one of the others by spoofing, but the most prominent of these, Opera, Konqueror, and
|
159
|
+
Safari, are taken care of.
|
160
|
+
|
161
|
+
IE - Internet Explorer
|
162
|
+
Firefox - Firefox and anything else based on the Gecko rendering engine.
|
163
|
+
Opera - Opera
|
164
|
+
Safari - Safari
|
165
|
+
Konqueror - Konqueror and anything else based on the KHTML rendering engine except Safari.
|
166
|
+
|
167
|
+
Browser Versions:
|
168
|
+
|
169
|
+
If the browser is not one of the versions below, this style will not be present. The browser type still may be.
|
170
|
+
|
171
|
+
IE6 - Internet Explorer 6.x.
|
172
|
+
IE7 - Internet Explorer 7.x.
|
173
|
+
|
174
|
+
Firefox1 - Firefox 1.0.x and anything else based on Gecko 1.7.x.
|
175
|
+
Firefox15 - Firefox 1.5.x and anything else based on Gecko 1.8.0.x.
|
176
|
+
Firefox2 - Firefox 2.0.x and anything else based on Gecko 1.8.1.x.
|
177
|
+
|
178
|
+
Opera7 - Opera 7.x.
|
179
|
+
Opera8 - Opera 8.x.
|
180
|
+
Opera9 - Opera 9.x.
|
181
|
+
|
182
|
+
Safari2 - Safari 2.x.
|
183
|
+
Safari3 - Safari 3.x.
|
184
|
+
|
185
|
+
Notes:
|
186
|
+
|
187
|
+
Why not apply them to the body tag itself? The JavaScript is easy enough and everything supports multiple classes, right?
|
188
|
+
Because IE 6 doesn't support multiple selectors so I wouldn't be able to combine browser and page styles.
|
189
|
+
.Opera.ContentPage will apply to all ContentPages in IE because it treats it as if only the last class is there.
|
190
|
+
|
191
|
+
|
192
|
+
|
193
|
+
|
194
|
+
Topic: Content Structure
|
195
|
+
_______________________________________________________________________________
|
196
|
+
|
197
|
+
|
198
|
+
All the topics of a given file is contained in a <#Content>. All other content styles are prefixed with a C.
|
199
|
+
|
200
|
+
Surrounding each piece of content is a <CTopic> and its type; for example, CFunction for a function. Inside that are the
|
201
|
+
<CTitle> and if necessary, <CBody>. Inside <CBody> are analogues to all the top-level <NDMarkup> tags: <h1>, <p>, etc.
|
202
|
+
|
203
|
+
In addition to the top-level <NDMarkup> tags, you also have prototypes, class hierarchies, and summaries which are
|
204
|
+
described in their own sections.
|
205
|
+
|
206
|
+
(start diagram)
|
207
|
+
|
208
|
+
<#Content>
|
209
|
+
|
210
|
+
<CType (CFunction, CVariable, etc.)>
|
211
|
+
<CTopic and #MainTopic?>
|
212
|
+
|
213
|
+
<CTitle>
|
214
|
+
Topic title
|
215
|
+
</CTitle>
|
216
|
+
|
217
|
+
<CBody>
|
218
|
+
|
219
|
+
[Class Hierarchy]
|
220
|
+
|
221
|
+
[Prototype]
|
222
|
+
|
223
|
+
<CHeading>
|
224
|
+
Heading
|
225
|
+
<CHeading>
|
226
|
+
|
227
|
+
<p>
|
228
|
+
Paragraph
|
229
|
+
</p>
|
230
|
+
|
231
|
+
<pre>
|
232
|
+
Code or text diagram
|
233
|
+
</pre>
|
234
|
+
|
235
|
+
<ul>
|
236
|
+
<li>
|
237
|
+
Bullet item
|
238
|
+
</li>
|
239
|
+
</ul>
|
240
|
+
|
241
|
+
<CImageCaption>?
|
242
|
+
Caption
|
243
|
+
</CImageCaption>?
|
244
|
+
<img>
|
245
|
+
|
246
|
+
<a CImageLink>
|
247
|
+
text
|
248
|
+
</a CImageLink>
|
249
|
+
|
250
|
+
<table CDescriptionList>
|
251
|
+
<tr>
|
252
|
+
<td CDLEntry>
|
253
|
+
Entry
|
254
|
+
</td CDLEntry>
|
255
|
+
<td CDLDescription>
|
256
|
+
Description
|
257
|
+
</td CDLDescription>
|
258
|
+
</tr>
|
259
|
+
</table CDescriptionList>
|
260
|
+
|
261
|
+
[Summary]
|
262
|
+
|
263
|
+
</CBody>
|
264
|
+
|
265
|
+
</CTopic and #MainTopic?>
|
266
|
+
</CType (CFunction, CVariable, etc.)>
|
267
|
+
|
268
|
+
</#Content>
|
269
|
+
|
270
|
+
(end diagram)
|
271
|
+
|
272
|
+
Take advantange of the CSS inheritance model. For example, you can style all titles via .CTitle, and you can style
|
273
|
+
specific titles with .CType .CTitle.
|
274
|
+
|
275
|
+
|
276
|
+
Styles: Content Styles
|
277
|
+
|
278
|
+
#Content - Parent element containing all topics.
|
279
|
+
|
280
|
+
CTopic - An individual topic.
|
281
|
+
|
282
|
+
CTitle - The title of a topic.
|
283
|
+
CBody - The body of a topic. May not exist.
|
284
|
+
CHeading - Surrounds a heading.
|
285
|
+
CImageCaption - Surrounds an image caption.
|
286
|
+
CImageLink - Surrounds a link to an image.
|
287
|
+
|
288
|
+
CDescriptionList - A description list, which is the type of list you're reading right now. Is implemented with a table.
|
289
|
+
CDLEntry - A description list entry, which is the left side.
|
290
|
+
CDLDescription - A description list description, which is the right side.
|
291
|
+
|
292
|
+
#MainTopic - The ID given to the main topic, which is the first in the file. It is applied to the <CTopic>.
|
293
|
+
|
294
|
+
CType - A placeholder for all type-specific styles. The actual styles will be C followed by the alphanumeric-only topic type name.
|
295
|
+
So the CType of a "PL/SQL Function" topic will actually be CPLSQLFunction.
|
296
|
+
|
297
|
+
|
298
|
+
|
299
|
+
|
300
|
+
Topic: Menu Structure
|
301
|
+
_______________________________________________________________________________
|
302
|
+
|
303
|
+
|
304
|
+
Everything is enclosed in a <#Menu>. All other menu styles are prefixed with an M.
|
305
|
+
|
306
|
+
The title is an <MTitle> and will always be at the beginning of the menu if it exists. If a subtitle exists as well, it will appear
|
307
|
+
as an <MSubTitle> inside <MTitle>. Subtitles aren't allowed without titles. Most other entries in the menu are contained in
|
308
|
+
<MEntries>. Here's the diagram:
|
309
|
+
|
310
|
+
(start diagram)
|
311
|
+
|
312
|
+
<#Menu>
|
313
|
+
|
314
|
+
<MTitle>
|
315
|
+
Menu title
|
316
|
+
|
317
|
+
<MSubTitle>
|
318
|
+
Menu sub title
|
319
|
+
</MSubTitle>
|
320
|
+
|
321
|
+
</MTitle>
|
322
|
+
|
323
|
+
<MEntry>
|
324
|
+
<MFile (and #MSelected?)>
|
325
|
+
<a href>File</a href>
|
326
|
+
</MFile>
|
327
|
+
</MEntry>
|
328
|
+
|
329
|
+
<MEntry>
|
330
|
+
<MIndex (and #MSelected?)>
|
331
|
+
<a href>File</a href>
|
332
|
+
</MIndex>
|
333
|
+
</MEntry>
|
334
|
+
|
335
|
+
<MEntry>
|
336
|
+
<MText>
|
337
|
+
Text
|
338
|
+
</MText>
|
339
|
+
</MEntry>
|
340
|
+
|
341
|
+
<MEntry>
|
342
|
+
<MLink>
|
343
|
+
<a href>Link</a href>
|
344
|
+
</MLink>
|
345
|
+
</MEntry>
|
346
|
+
|
347
|
+
<MEntry>
|
348
|
+
<MGroup>
|
349
|
+
<a href>Group</a href>
|
350
|
+
<MGroupContent>
|
351
|
+
|
352
|
+
(MEntries)
|
353
|
+
|
354
|
+
</MGroupContent>
|
355
|
+
</MGroup>
|
356
|
+
</MEntry>
|
357
|
+
|
358
|
+
<#MSearchPanel and MSearchPanelActive/Inactive>
|
359
|
+
<input #MSeachField>
|
360
|
+
<select #MSearchType>
|
361
|
+
<option #MSearchEverything>
|
362
|
+
<option>
|
363
|
+
<option>
|
364
|
+
</select #MSearchType>
|
365
|
+
</#MSearchPanel and MSearchPanelActive/Inactive>
|
366
|
+
|
367
|
+
</#Menu>
|
368
|
+
|
369
|
+
(if in unframed HTML)
|
370
|
+
<#MSearchResultsWindow>
|
371
|
+
|
372
|
+
<iframe #MSearchResults>
|
373
|
+
</iframe #MSearchResults>
|
374
|
+
|
375
|
+
<a #MSearchResultsWindowClose>
|
376
|
+
|
377
|
+
</#MSearchResultsWindow>
|
378
|
+
|
379
|
+
(end)
|
380
|
+
|
381
|
+
The <MFile> or <MIndex> entry that's currently selected will have the <#MSelected> ID, so you can reference it in CSS via
|
382
|
+
.MFile#MSelected.
|
383
|
+
|
384
|
+
The search panel is has its own ID, <#MSearchPanel>, but also has one of the classes <MSearchPanelActive> or
|
385
|
+
<MSearchPanelInactive> depending on whether any of the controls are selected or the results window is open.
|
386
|
+
<#MSearchResultsWindow> is separate because it may be floating.
|
387
|
+
|
388
|
+
|
389
|
+
Styles: Menu Styles
|
390
|
+
|
391
|
+
#Menu - Parent element containing the entire menu.
|
392
|
+
|
393
|
+
MTitle - The title of the menu.
|
394
|
+
MSubTitle - The subtitle of the menu. Will appear within <MTitle>.
|
395
|
+
|
396
|
+
MFile - A file entry.
|
397
|
+
MGroup - A group entry.
|
398
|
+
MGroupContent - A container for a <MGroup's> content.
|
399
|
+
MText - A plain text entry.
|
400
|
+
MLink - An external link entry.
|
401
|
+
MIndex - An index entry.
|
402
|
+
|
403
|
+
#MSelected - The ID of the currently selected <MFile> or <MIndex>.
|
404
|
+
|
405
|
+
MType - <MFile>, <MGroup>, <MText>, <MLink>, or <MIndex>.
|
406
|
+
|
407
|
+
#MSearchPanel - Contains all the search controls.
|
408
|
+
MSearchPanelActive - Applied to <#MSearchPanel> when any of the controls are selected or the results window is open.
|
409
|
+
MSearchPanelInactive - Applied to <#MSearchPanel> when not in use.
|
410
|
+
|
411
|
+
#MSearchField - The text input field of the search panel.
|
412
|
+
#MSearchType - The drop down type selector of the search panel.
|
413
|
+
#MSearchEverything - The <#MSearchType> option for the Everything index.
|
414
|
+
|
415
|
+
#MSearchResultsWindow - Contains all the search results elements.
|
416
|
+
#MSearchResults - Contains the iframe that will hold the results.
|
417
|
+
#MSearchRseultsWindowClose - The link to manually close the search results window.
|
418
|
+
|
419
|
+
|
420
|
+
|
421
|
+
|
422
|
+
Topic: Class Hierarchy Structure
|
423
|
+
_______________________________________________________________________________
|
424
|
+
|
425
|
+
|
426
|
+
Everything is contained in a single <ClassHierarchy>. Each entry is surrounded by its type, such as <CHParent>, and the
|
427
|
+
generic <CHEntry>. Depending on the context, entries may be surrounded by one or more <CHIndents>.
|
428
|
+
|
429
|
+
(start diagram)
|
430
|
+
|
431
|
+
<ClassHierarchy>
|
432
|
+
|
433
|
+
<CHIndent>?
|
434
|
+
|
435
|
+
<CHType>
|
436
|
+
<CHEntry>
|
437
|
+
|
438
|
+
<a href>?
|
439
|
+
Entry
|
440
|
+
</a href>
|
441
|
+
|
442
|
+
</CHEntry>
|
443
|
+
</CHType>
|
444
|
+
|
445
|
+
</CHIndent>?
|
446
|
+
|
447
|
+
</ClassHierarchy>
|
448
|
+
|
449
|
+
(end diagram)
|
450
|
+
|
451
|
+
|
452
|
+
Styles: Class Hierarchy Styles
|
453
|
+
|
454
|
+
ClassHierarchy - The topmost style containing everything.
|
455
|
+
|
456
|
+
CHEntry - A generic class entry.
|
457
|
+
|
458
|
+
CHParent - The style for a parent class.
|
459
|
+
CHCurrent - The style for the current class, which is the one the hierarchy is generated for.
|
460
|
+
CHChild - The style for a child class.
|
461
|
+
CHChildNote - The style for when a child is added that just shows how many other children were omitted.
|
462
|
+
|
463
|
+
CHIndent - A style used to indent a level.
|
464
|
+
|
465
|
+
CHType - <CHParent>, <CHCurrent>, <CHChild>, or <CHChildNote>.
|
466
|
+
|
467
|
+
|
468
|
+
|
469
|
+
|
470
|
+
Topic: Summary Structure
|
471
|
+
_______________________________________________________________________________
|
472
|
+
|
473
|
+
|
474
|
+
Everything is enclosed in a single <Summary>. All the other summary styles are prefixed with an S.
|
475
|
+
|
476
|
+
<STitle> holds the actual word "Summary" and <SBorder> and <STable> hold the content. <SBorder> exists because different
|
477
|
+
browsers apply table padding attributes in different ways. <STable> exists as a class to separate the main table from any other
|
478
|
+
tables that may be necessary. Here's a diagram:
|
479
|
+
|
480
|
+
> <Summary>
|
481
|
+
>
|
482
|
+
> <STitle>
|
483
|
+
> Title
|
484
|
+
> </STitle>
|
485
|
+
>
|
486
|
+
> <SBorder>
|
487
|
+
> <table STable>
|
488
|
+
> ...
|
489
|
+
> </table STable>
|
490
|
+
> </SBorder>
|
491
|
+
>
|
492
|
+
> </Summary>
|
493
|
+
|
494
|
+
On to the table content.
|
495
|
+
|
496
|
+
> <tr SType and SEntry (and SIndent#?) (and SMarked?)>
|
497
|
+
> <td SEntry>
|
498
|
+
>
|
499
|
+
> <a href>Entry</a href>
|
500
|
+
>
|
501
|
+
> </td SEntry>
|
502
|
+
> <td SDescription>
|
503
|
+
>
|
504
|
+
> Description
|
505
|
+
>
|
506
|
+
> </td SDescription>
|
507
|
+
> </tr SType and SEntry (and SIndent#?) (and SMarked?)>
|
508
|
+
|
509
|
+
<SIndent#> exist to allow indenting. They're necessary because implementing it as nested tables, while structurally cleaner,
|
510
|
+
won't allow the desciptions to line up on the right throughout the entire summary. <SMarked> will be applied on almost every
|
511
|
+
other row to allow for tinting to improve readability.
|
512
|
+
|
513
|
+
Use the power of CSS's inheritance rules to specify styles. For example, to set the style of a group entry, apply it to
|
514
|
+
.SGroup .SEntry. However, you could also apply a style to both the group's entry and description by applying the
|
515
|
+
style to .SGroup td. Or, you could apply a style to all the entries by applying it to .SEntry. And so on.
|
516
|
+
|
517
|
+
|
518
|
+
Styles: Summary Styles
|
519
|
+
|
520
|
+
Summary - The topmost style containing the entire summary.
|
521
|
+
|
522
|
+
STitle - Contains the summary title, which is the part that actually says "Summary".
|
523
|
+
|
524
|
+
SBorder - Surrounds <STable>, since some browsers can't do table padding right. A hack, I know.
|
525
|
+
STable - The actual summary table. This class separates it from other layout tables that may appear.
|
526
|
+
|
527
|
+
SMarked - A class applied to rows that should have a slightly different color than the rest of the rows to make them easier to
|
528
|
+
read.
|
529
|
+
|
530
|
+
SEntry - The entry (left) side of the table.
|
531
|
+
SDescription - The description (right) side of the table.
|
532
|
+
|
533
|
+
SIndent# - Surrounding entries and descriptions that are part of a group and need to be indented. Actual styles will be
|
534
|
+
SIndent1, SIndent2, etc.
|
535
|
+
|
536
|
+
SType - A placeholder for all topic-specific styles. The actual styles will be S followed by the alphanumeric-only topic type name.
|
537
|
+
So the SType of a "PL/SQL Function" topic will actually be SPLSQLFunction.
|
538
|
+
|
539
|
+
|
540
|
+
|
541
|
+
|
542
|
+
Topic: Prototype Structure
|
543
|
+
_______________________________________________________________________________
|
544
|
+
|
545
|
+
|
546
|
+
Everything is enclosed in a <Prototype>. All other styles are prefixed with a P.
|
547
|
+
|
548
|
+
Parameter Type First Style:
|
549
|
+
|
550
|
+
For prototypes such as
|
551
|
+
> void Function (unsigned int* a, int b = 0)
|
552
|
+
where the types come first.
|
553
|
+
|
554
|
+
(start diagram)
|
555
|
+
|
556
|
+
<table Prototype>
|
557
|
+
|
558
|
+
<td PBeforeParameters>
|
559
|
+
"void Function ("
|
560
|
+
</td PBeforeParameters>
|
561
|
+
|
562
|
+
<td PTypePrefix>
|
563
|
+
"unsigned"
|
564
|
+
</td PTypePrefix>
|
565
|
+
|
566
|
+
<td PType>
|
567
|
+
"int"
|
568
|
+
</td PType>
|
569
|
+
|
570
|
+
<td PParameterPrefix>
|
571
|
+
"*"
|
572
|
+
</td PParameterPrefix>
|
573
|
+
|
574
|
+
<td PParameter>
|
575
|
+
"a", "b"
|
576
|
+
</td PParameter>
|
577
|
+
|
578
|
+
<td PDefaultValuePrefix>
|
579
|
+
"="
|
580
|
+
</td PDefaultValuePrefix>
|
581
|
+
|
582
|
+
<td PDefaultValue>
|
583
|
+
"0"
|
584
|
+
</td PDefaultValue>
|
585
|
+
|
586
|
+
(repeated as necessary)
|
587
|
+
|
588
|
+
<td PAfterParameters>
|
589
|
+
")"
|
590
|
+
</td PAfterParameters>
|
591
|
+
|
592
|
+
</table Prototype>
|
593
|
+
|
594
|
+
(end diagram)
|
595
|
+
|
596
|
+
|
597
|
+
Parameter Name First Style:
|
598
|
+
|
599
|
+
For prototypes such as
|
600
|
+
> function Function (a, b: int; c: int := 0)
|
601
|
+
where the parameters come first.
|
602
|
+
|
603
|
+
(start diagram)
|
604
|
+
|
605
|
+
<table Prototype>
|
606
|
+
|
607
|
+
<td PBeforeParameters>
|
608
|
+
"function Function ("
|
609
|
+
</td PBeforeParameters>
|
610
|
+
|
611
|
+
<td PParameter>
|
612
|
+
"a,", "b:", "c:"
|
613
|
+
</td PParameter>
|
614
|
+
|
615
|
+
<td PType>
|
616
|
+
"int"
|
617
|
+
</td PType>
|
618
|
+
|
619
|
+
<td PDefaultValuePrefix>
|
620
|
+
":="
|
621
|
+
</td PDefaultValuePrefix>
|
622
|
+
|
623
|
+
<td PDefaultValue>
|
624
|
+
"0"
|
625
|
+
</td PDefaultValue>
|
626
|
+
|
627
|
+
(repeated as necessary)
|
628
|
+
|
629
|
+
<td PAfterParameters>
|
630
|
+
")"
|
631
|
+
</td PAfterParameters>
|
632
|
+
|
633
|
+
</table Prototype>
|
634
|
+
|
635
|
+
(end diagram)
|
636
|
+
|
637
|
+
|
638
|
+
Note that any section may not exist. For example, there will be no <PTypePrefix> cells generated if none of the parameters
|
639
|
+
have it.
|
640
|
+
|
641
|
+
|
642
|
+
Styles: Prototype Styles
|
643
|
+
|
644
|
+
Prototype - The style encompassing the entire prototype.
|
645
|
+
|
646
|
+
PBeforeParameters - The part of the prototype that comes before the parameters.
|
647
|
+
PAfterParameters - The part of the prototype that comes after the parameters.
|
648
|
+
|
649
|
+
PType - The parameter type.
|
650
|
+
PTypePrefix - The prefix of a parameter type.
|
651
|
+
PParameter - The parameter name.
|
652
|
+
PParameterPrefix - The prefix of a parameter name.
|
653
|
+
PDefaultValue - The default value expression for a parameter.
|
654
|
+
PDefaultValuePrefix - The prefix of the default value expression.
|
655
|
+
|
656
|
+
|
657
|
+
|
658
|
+
|
659
|
+
Topic: Link Structure
|
660
|
+
_______________________________________________________________________________
|
661
|
+
|
662
|
+
|
663
|
+
All links to symbols have a type style prefixed with L. The only exceptions are summary entries; summary descriptions use
|
664
|
+
them as well.
|
665
|
+
|
666
|
+
> <a LType>
|
667
|
+
> Link
|
668
|
+
> </a LType>
|
669
|
+
|
670
|
+
You can use this to make links to different symbols appear in different styles. For example, making .LClass bold will make all
|
671
|
+
links to classes bold, except when appearing in summary entries. You can combine this with other styles to be even more
|
672
|
+
specific. For example, you can apply a style to function links appearing in summary descriptions with .SDescription .LFunction.
|
673
|
+
|
674
|
+
Styles: Link Styles
|
675
|
+
|
676
|
+
LType - A placeholder for all topic-specific styles. The actual styles will be L followed by the alphanumeric-only topic type name.
|
677
|
+
So the LType of a "PL/SQL Function" topic will actually be LPLSQLFunction.
|
678
|
+
|
679
|
+
|
680
|
+
|
681
|
+
Topic: Index Structure
|
682
|
+
_______________________________________________________________________________
|
683
|
+
|
684
|
+
|
685
|
+
Everything is enclosed in an <#Index>. Combine with <Framed> and <Unframed> to distinguish between output formats. All
|
686
|
+
other index styles are prefixed with an I.
|
687
|
+
|
688
|
+
(start diagram)
|
689
|
+
|
690
|
+
<#Index>
|
691
|
+
|
692
|
+
<IPageTitle>
|
693
|
+
Page Title
|
694
|
+
</IPageTitle>
|
695
|
+
|
696
|
+
<INavigationBar>
|
697
|
+
A - <a href>B</a href> - C ...
|
698
|
+
</INavigationBar>
|
699
|
+
|
700
|
+
<table>
|
701
|
+
|
702
|
+
<IHeading>
|
703
|
+
Heading (A, B, etc.)
|
704
|
+
</IHeading>
|
705
|
+
|
706
|
+
<td ISymbolPrefix>
|
707
|
+
Prefix, if any
|
708
|
+
</td ISymbolPrefix>
|
709
|
+
|
710
|
+
<td IEntry>
|
711
|
+
Entry
|
712
|
+
</td IEntry>
|
713
|
+
|
714
|
+
...
|
715
|
+
|
716
|
+
</table>
|
717
|
+
|
718
|
+
</#Index>
|
719
|
+
|
720
|
+
(end diagram)
|
721
|
+
|
722
|
+
Every index entry, including headings, are rows in a table. The first column of a non-heading are <ISymbolPrefixes> so that
|
723
|
+
the non-prefix portions align correctly. The other column are <IEntries>, of which there are multiple formats, described below.
|
724
|
+
|
725
|
+
(start diagram)
|
726
|
+
|
727
|
+
<a href ISymbol>
|
728
|
+
Symbol
|
729
|
+
</a href ISymbol>,
|
730
|
+
<IParent>
|
731
|
+
Class
|
732
|
+
</IParent>
|
733
|
+
|
734
|
+
<ISymbol>
|
735
|
+
Symbol
|
736
|
+
</ISymbol>
|
737
|
+
<ISubIndex>
|
738
|
+
<a href IParent>
|
739
|
+
Class
|
740
|
+
</a href IParent>
|
741
|
+
...
|
742
|
+
</ISubIndex>
|
743
|
+
|
744
|
+
<ISymbol>
|
745
|
+
Symbol
|
746
|
+
</ISymbol>
|
747
|
+
<ISubIndex>
|
748
|
+
<IParent>
|
749
|
+
Class
|
750
|
+
</IParent>
|
751
|
+
<ISubIndex>
|
752
|
+
<a href IFile>
|
753
|
+
File
|
754
|
+
</a href IFile>
|
755
|
+
...
|
756
|
+
</ISubIndex>
|
757
|
+
...
|
758
|
+
</ISubIndex>
|
759
|
+
|
760
|
+
(end diagram)
|
761
|
+
|
762
|
+
Each part of the entry is surrounded by its type, which may or may not be a link. If an entry has more than one defining class
|
763
|
+
or file, they're broken out into <ISubIndexes>.
|
764
|
+
|
765
|
+
It's called <IParent> instead of <IClass> because class entries are <ISymbols>. <IParents> are only used when the symbol
|
766
|
+
has a class. If the symbol _is_ a class, the symbol is global.
|
767
|
+
|
768
|
+
|
769
|
+
Styles: Index Styles
|
770
|
+
|
771
|
+
#Index - Parent element for the entire index.
|
772
|
+
|
773
|
+
IPageTitle - The page title.
|
774
|
+
INavigationBar - The navigation bar.
|
775
|
+
|
776
|
+
IHeading - An index heading, such as the letter for the group.
|
777
|
+
|
778
|
+
IEntry - An entry in the index.
|
779
|
+
ISymbolPrefix - The stripped prefix of the entry.
|
780
|
+
ISymbol - The entry symbol.
|
781
|
+
IParent - The entry parent class. If the entry _is_ a class, this isn't defined because classes are global and don't have parent
|
782
|
+
classes. This is why it's called IParent instead of IClass; hopefully it's less confusing.
|
783
|
+
IFile - The file the entry is defined in.
|
784
|
+
|
785
|
+
ISubIndex - The surrounding block if an entry needs to be broken out into a sub-index.
|
786
|
+
|
787
|
+
#IFirstHeading - The ID of the first <IHeading> to appear in the file.
|
788
|
+
|
789
|
+
#IFirstSymbolPrefix - The ID for the first <ISymbolPrefix> to appear under an <IHeading>.
|
790
|
+
#ILastSymbolPrefix - The ID for the last <ISymbolPrefix> to appear under an <IHeading>.
|
791
|
+
#IOnlySymbolPrefix - The ID if there is only one <ISymbolPrefix> for an <IHeading>.
|
792
|
+
|
793
|
+
|
794
|
+
|
795
|
+
Topic: Search Results Structure
|
796
|
+
_______________________________________________________________________________
|
797
|
+
|
798
|
+
|
799
|
+
The search results use virtually the same structure and styles as the indexes, except that <#SearchResults> replaces
|
800
|
+
<#Index>, there's a new <SRResult> style, and there are a few additional <SRStatus> blocks.
|
801
|
+
|
802
|
+
Visibility:
|
803
|
+
|
804
|
+
Visibility is *very* important to making the search work correctly. JavaScript will handle most of it, but your CSS needs to
|
805
|
+
abide by these rules.
|
806
|
+
|
807
|
+
- <SRStatus> sections are visible by default.
|
808
|
+
- <SRResult> sections are *not* visible by default. They must use display: none.
|
809
|
+
- <ISubIndex> should be display: none when under <#SearchResults>.
|
810
|
+
|
811
|
+
|
812
|
+
Styles: Search Results Styles
|
813
|
+
|
814
|
+
#SearchResults - Parent element for the entire page.
|
815
|
+
SRStatus - Status message. Must be visible by default.
|
816
|
+
SRResult - A result. All you need to do for this class is set it to display: none. Nothing else should be set on it.
|
817
|
+
|
818
|
+
|
819
|
+
|
820
|
+
|
821
|
+
Topic: Tool Tip Structure
|
822
|
+
_______________________________________________________________________________
|
823
|
+
|
824
|
+
|
825
|
+
Tool tips may appear anywhere in the page, mainly because it's assumed that they will use position: absolute and
|
826
|
+
visibility: hidden.
|
827
|
+
|
828
|
+
The entire tool tip is found in a <CToolTip> style, with a CType style inside it. CTypes are normally outside their elements, but
|
829
|
+
that would cause it to be partially visible in this case. We need <CToolTip> to be the outermost style so its visibility and
|
830
|
+
position can be manipulated in JavaScript.
|
831
|
+
|
832
|
+
Inside there's a <CPrototype> and/or the description text. The description text has no special surrounding tags.
|
833
|
+
|
834
|
+
> <CToolTip>
|
835
|
+
>
|
836
|
+
> <CPrototype>
|
837
|
+
> Prototype
|
838
|
+
> </CPrototype>
|
839
|
+
>
|
840
|
+
> Summary text
|
841
|
+
>
|
842
|
+
> </CToolTip>
|
843
|
+
|
844
|
+
Styles: Tool Tip Styles
|
845
|
+
|
846
|
+
CToolTip - Surrounds the entire tool tip. This *must* have position: absolute and visibility: hidden for the tool tip mechanism
|
847
|
+
to work.
|
848
|
+
|
849
|
+
See also <CPrototype>.
|
850
|
+
|
851
|
+
|
852
|
+
Styles: Miscellaneous Styles
|
853
|
+
|
854
|
+
blockquote - This HTML element should surround anything that needs to be scrolled if it's too wide, like prototypes and text
|
855
|
+
diagrams. It's not a style because this makes it much easier to do the JavaScript necessary to get this working
|
856
|
+
in IE.
|
857
|
+
|
858
|
+
|
859
|
+
Group: History
|
860
|
+
|
861
|
+
Topic: Revisions
|
862
|
+
_______________________________________________________________________________
|
863
|
+
|
864
|
+
|
865
|
+
How the page structure has changed throughout the various releases.
|
866
|
+
|
867
|
+
1.4:
|
868
|
+
|
869
|
+
- Replaced UnframedPage with <ContentPage> and <IndexPage>.
|
870
|
+
- Added <#Menu>, <#Content>, <#Footer>, and <#Index>. They were previously shown in the diagrams as classes but did
|
871
|
+
not actually appear in the generated output.
|
872
|
+
- Removed MenuSection, ContentSection, and IndexSection. Use things like ".ContentPage #Menu" instead.
|
873
|
+
- Removed tables from the unframed <Page Structure>. Use CSS to position the elements instead.
|
874
|
+
- <#MainTopic> is applied to <CTopic> instead of <CType>.
|
875
|
+
- IE4, IE5, Opera5, Opera6, Netscape, and Netscape4 browser styles have been removed. <IE7>, <Opera8>,
|
876
|
+
and <Opera9> have been added. Gecko has been replaced by <Firefox>, <Firefox1>, <Firefox15>, and <Firefox2>.
|
877
|
+
KHTML has been replaced by <Safari>, <Safari2>, <Safari3>, and <Konqueror>.
|
878
|
+
- Removed redundant CParagraph, CCode, and CBulletList classes. Use <CBody> with p, pre, and ul instead.
|
879
|
+
- Added <CImageCaption> and <CImageLink>.
|
880
|
+
- Added <#MSearchPanel>, <#MSearchResultsWindow>, and all related styles.
|
881
|
+
- Added <Search Results Structure>, <Search Results Styles>, and <FramedSearchResultsPage>.
|
882
|
+
- Removed SEntrySize. Apply the width to <SEntry> and <SDescription> instead.
|
883
|
+
- <SType>, <SEntry>, and <SIndent#> were moved from the td and divs into the tr.
|
884
|
+
- Removed HB style. Now using wbr tag.
|
885
|
+
|
886
|
+
1.33:
|
887
|
+
|
888
|
+
- Added <PDefaultValuePrefix>.
|
889
|
+
|
890
|
+
1.32:
|
891
|
+
|
892
|
+
- <blockquotes> now surround elements that should scroll if they're too wide for the page.
|
893
|
+
|
894
|
+
1.3:
|
895
|
+
|
896
|
+
- Removed CPrototype. See the replacement <Prototype Structure> and <Prototype Styles>.
|
897
|
+
- Removed SInGroup, SInClass, and SInSection in favor of more general <SIndent#>.
|
898
|
+
- <CTypes>, <STypes>, and <LTypes> are now completely determined by <Topics.txt> configuration files.
|
899
|
+
- <CTypes>, <STypes>, and <LTypes> no longer have separate list types. A CFunctionList is now just a CFunction.
|
900
|
+
- Indexes are now done with tables.
|
901
|
+
- ISection was removed.
|
902
|
+
- <IEntries> are only used for the entry cell, not for each entry in an <ISubIndex>.
|
903
|
+
- Added <ISymbolPrefix>, related IDs, and <#IFirstHeading>.
|
904
|
+
- Merged <CType> and <CTopic> into the same element. Must now be styled with .CType.CTopic (no space) while all
|
905
|
+
sub-elements will still be .CType .CElement (with space.)
|
906
|
+
|
907
|
+
1.21:
|
908
|
+
|
909
|
+
- Added <TOPIC_PROPERTY> and TOPIC_PROPERTY_LIST styles, so they get corresponding <CTypes>, <STypes>, and
|
910
|
+
<LTypes>.
|
911
|
+
|
912
|
+
1.2:
|
913
|
+
|
914
|
+
- Added <Class Hierarchy Styles> since 1.2 added class hierarchies.
|
915
|
+
|
916
|
+
1.16:
|
917
|
+
|
918
|
+
- Changed the first topic from having a CMain type to having a normal type with a <#MainTopic> ID.
|
919
|
+
|
920
|
+
1.1:
|
921
|
+
|
922
|
+
- Added <Tool Tip Styles>.
|
923
|
+
- Renamed HiddenBreak to <HB>.
|
924
|
+
- Added <TOPIC_CONSTANT>, TOPIC_CONSTANT_LIST, <TOPIC_TYPE>, and TOPIC_TYPE_LIST types, so they get
|
925
|
+
corresponding <CTypes>, <STypes>, and <LTypes>.
|
926
|
+
|
927
|
+
1.0:
|
928
|
+
|
929
|
+
- The <CType> tags now appear arround the <CTopic> tags instead of vice versa.
|
930
|
+
- Added a <CBody> tag to surround non-<CTitle> elements.
|
931
|
+
- <SMarked> now appears in tr's instead of td's, where it belonged in the first place.
|
932
|
+
|
933
|
+
0.95:
|
934
|
+
|
935
|
+
- Added <Browser Styles>.
|
936
|
+
- Redid <Page Structure>, replacing generic styles like Menu with page type styles like UnframedPage/MenuSection and
|
937
|
+
FramedMenuPage.
|
938
|
+
|
939
|
+
0.91:
|
940
|
+
|
941
|
+
- Added <LURL> and <LEMail> link styles, since 0.91 added URL and e-mail links.
|
942
|
+
- Added <ISection> style, which is better than <IHeading> floating on its own.
|
943
|
+
|
944
|
+
0.9:
|
945
|
+
|
946
|
+
- Added <Index Styles>, since 0.9 added indexes.
|
947
|
+
|