The best way to learn how to use the WebCore is by example. See the documentation for more information.
The requested URL is always shown first; if a page uses one or more WebCore templates, those are shown afterwards.
00 <?php
01 include_once ('software/webcore_init.php');
02
03 $Page->title->subject = 'Documentation';
04 $Page->location->append ('WebCore', './');
05 $Page->location->append ('Documentation');
06
07 $renderer = $Page->make_controls_renderer ();
08
09 $Page->start_display ();
10 ?>
11 <div class="top-box">
12 <div class="button-content">
13 <a href="develop.php" class="button">< Develop</a>
14 </div>
15 </div>
16 <div class="main-box">
17 <div class="columns text-flow">
18 <div>
19 <p>The WebCore and all applications are fully documented with <a href="http://www.phpdoc.org/">PHPDocumentor</a>*.</p>
20 <ul>
21 <li>Every class, property, method and variable is marked up with JavaDoc-style tags.
22 The documentation is in front of you as you browse the code and JavaDoc-aware editors
23 can generate code-completion information and in-place help while you work.</li>
24 <li>Source code is syntax-highlighted and linked with the documentation.</li>
25 <li>All applications are documented too, so you can use them as examples.</li>
26 </ul>
27 <p>The WebCore API is separated into <em>lite</em> and <em>full</em> versions.</p>
28 <p class="info-box-bottom">*I highly recommend PHPDoc (not least because I spent some time
29 extending it just so it could handle the WebCore!).</p>
30 <h2>Lite (public API only)</h2>
31 <ul>
32 <li>Provides a clear picture of what the WebCore does, rather than how it does it.</li>
33 <li>Includes only the higher-level API, leaving off implementation details, such as
34 internal functions and classes.</li>
35 </ul>
36 <?php
37 $buttons = array ();
38 $buttons [] = $renderer->button_as_html ('Download', 'download.php#developer_tools', '{icons}buttons/download', Sixteen_px);
39 $buttons [] = $renderer->button_as_html ('Browse', $Page->resolve_file ('{data}/software/webcore/docs/public/'), '{icons}buttons/source', Sixteen_px);
40 $renderer->draw_buttons ($buttons);
41 ?>
42 <h2>Full (developer API)</h2>
43 <ul>
44 <li>Good for developing a new application or heavily customizing an existing one.</li>
45 <li>Includes absolutely every last little implementation detail: almost everything is documented
46 to some degree.</li>
47 <li>Shows you all of the aggravation the WebCore is sparing you!</li>
48 </ul>
49 <?php
50 $buttons = array ();
51 $buttons [] = $renderer->button_as_html ('Download', 'download.php#developer_tools', '{icons}buttons/download', Sixteen_px);
52 $buttons [] = $renderer->button_as_html ('Browse', $Page->resolve_file ('{data}/software/webcore/docs/developer/'), '{icons}buttons/source', Sixteen_px);
53 $renderer->draw_buttons ($buttons);
54 ?>
55 </div>
56 <div class="right-sidebar">
57 <p><?php echo $Page->resolve_icon_as_html ('{icons}buttons/source', One_hundred_px, ''); ?></p>
58 <p>Click "View source" at the top right of most pages to learn by example.</p>
59 </div>
60 </div>
61 </div>
62 <?php $Page->finish_display (); ?>