incubator-zeta-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From k...@apache.org
Subject [zeta-commits] svn commit: r981774 [38/38] - in /incubator/zetacomponents/website: ./ build/ config/ config/content/ config/display/ content/ content/community/ content/community/ressources/ content/documentation/ content/documentation/trunk/ content/documentation/tr...
Date Tue, 03 Aug 2010 08:25:19 GMT
Added: incubator/zetacomponents/website/phpdoc/Converters/HTML/Arbit/templates/arbit/templates/var.tpl
URL: http://svn.apache.org/viewvc/incubator/zetacomponents/website/phpdoc/Converters/HTML/Arbit/templates/arbit/templates/var.tpl?rev=981774&view=auto
==============================================================================
--- incubator/zetacomponents/website/phpdoc/Converters/HTML/Arbit/templates/arbit/templates/var.tpl
(added)
+++ incubator/zetacomponents/website/phpdoc/Converters/HTML/Arbit/templates/arbit/templates/var.tpl
Tue Aug  3 08:23:50 2010
@@ -0,0 +1,94 @@
+{section name=vars loop=$vars}
+{if $vars[vars].static}
+<a name="var{$vars[vars].var_name}" id="{$vars[vars].var_name}"><!-- --></A>
+<div class="{cycle values="evenrow,oddrow"}">
+
+    <div class="var-header">
+        <span class="var-title">
+            static <span class="var-type">{$vars[vars].var_type}</span>&#8192;&#8192;
+            <span class="var-name">{$vars[vars].var_name}</span>
+            {if $vars[vars].var_default} = <span class="var-default">{$vars[vars].var_default|replace:"\n":"<br
/>"}</span>{/if}
+            <span class="smalllinenumber">[line {if $vars[vars].slink}{$vars[vars].slink}{else}{$vars[vars].line_number}{/if}]</span>
+        </span>
+    </div>
+
+    {include file="docblock.tpl" sdesc=$vars[vars].sdesc desc=$vars[vars].desc}
+    {include file="tags.tpl" api_tags=$vars[vars].api_tags info_tags=$vars[vars].info_tags}
+
+    {if $vars[vars].var_overrides}
+        <hr class="separator" />
+        <div class="notes">Redefinition of:</div>
+        <dl>
+            <dt>{$vars[vars].var_overrides.link}</dt>
+            {if $vars[vars].var_overrides.sdesc}
+            <dd>{$vars[vars].var_overrides.sdesc|replace:"&nbsp;":"&#8192;"}</dd>
+            {/if}
+        </dl>
+    {/if}
+
+    {if $vars[vars].descvar}
+        <hr class="separator" />
+        <div class="notes">Redefined in descendants as:</div>
+        <ul class="redefinitions">
+        {section name=vm loop=$vars[vars].descvar}
+            <li>
+                {$vars[vars].descvar[vm].link}
+                {if $vars[vars].descvar[vm].sdesc}
+                : {$vars[vars].descvar[vm].sdesc|replace:"&nbsp;":"&#8192;"}
+                {/if}
+            </li>
+        {/section}
+        </ul>
+    {/if}
+    <br />
+    <div class="top">[ <a href="#top">Top</a> ]</div>
+</div>
+{/if}
+{/section}
+{section name=vars loop=$vars}
+{if !$vars[vars].static}
+<a name="var{$vars[vars].var_name}" id="{$vars[vars].var_name}"><!-- --></A>
+<div class="{cycle values="evenrow,oddrow"}">
+
+    <div class="var-header">
+        <span class="var-title">
+            <span class="var-type">{$vars[vars].var_type}</span>&#8192;&#8192;
+            <span class="var-name">{$vars[vars].var_name}</span>
+            {if $vars[vars].var_default} = <span class="var-default">{$vars[vars].var_default|replace:"\n":"<br
/>"}</span>{/if}
+            <span class="smalllinenumber">[line {if $vars[vars].slink}{$vars[vars].slink}{else}{$vars[vars].line_number}{/if}]</span>
+        </span>
+    </div>
+
+    {include file="docblock.tpl" sdesc=$vars[vars].sdesc desc=$vars[vars].desc}
+    {include file="tags.tpl" api_tags=$vars[vars].api_tags info_tags=$vars[vars].info_tags}
+
+    {if $vars[vars].var_overrides}
+        <hr class="separator" />
+        <div class="notes">Redefinition of:</div>
+        <dl>
+            <dt>{$vars[vars].var_overrides.link}</dt>
+            {if $vars[vars].var_overrides.sdesc}
+            <dd>{$vars[vars].var_overrides.sdesc|replace:"&nbsp;":"&#8192;"}</dd>
+            {/if}
+        </dl>
+    {/if}
+
+    {if $vars[vars].descvar}
+        <hr class="separator" />
+        <div class="notes">Redefined in descendants as:</div>
+        <ul class="redefinitions">
+        {section name=vm loop=$vars[vars].descvar}
+            <li>
+                {$vars[vars].descvar[vm].link}
+                {if $vars[vars].descvar[vm].sdesc}
+                : {$vars[vars].descvar[vm].sdesc|replace:"&nbsp;":"&#8192;"}
+                {/if}
+            </li>
+        {/section}
+        </ul>
+    {/if}
+    <br />
+    <div class="top">[ <a href="#top">Top</a> ]</div>
+</div>
+{/if}
+{/section}

Added: incubator/zetacomponents/website/phpdoc/Converters/HTML/Arbit/templates/arbit/templates_c/empty.txt
URL: http://svn.apache.org/viewvc/incubator/zetacomponents/website/phpdoc/Converters/HTML/Arbit/templates/arbit/templates_c/empty.txt?rev=981774&view=auto
==============================================================================
    (empty)

Added: incubator/zetacomponents/website/readme.txt
URL: http://svn.apache.org/viewvc/incubator/zetacomponents/website/readme.txt?rev=981774&view=auto
==============================================================================
--- incubator/zetacomponents/website/readme.txt (added)
+++ incubator/zetacomponents/website/readme.txt Tue Aug  3 08:23:50 2010
@@ -0,0 +1,104 @@
+=======
+Read me
+=======
+
+This reprository contains all tools required to build the Apache zeta
+Components website. It is based on a GNU make script and using WCV__ for the
+HTML geenration.
+
+__ http://web-content-viewer.org/
+
+Usage
+=====
+
+To regenerate the website just execute::
+
+    make website
+
+All required steps will be performed. Afterwards the generated website is
+available in ``htdocs`` and can be committed.
+
+Doc rebuilding
+==============
+
+The website contains two kinds of documentation:
+
+- The tutorials
+- The API documentation
+
+They are generated seperately:
+
+The API documentation
+---------------------
+
+The API docs are build using *phpdoc* and currently requires about 2,5GB of
+free memory to build. by default the API documentation is build for ``trunk/``
+when calling ``make phpdoc``. You can pass specific release information to the
+build process like this::
+
+    ZETA_BASE=/path/to/zeta/2023.42 make -e phpdoc
+
+This will build an archive containing the API documentation and move it to the
+correct location in the content folder. You can just commit the content folder
+afterwards.
+
+To make the API documentation available for the website you also need to call
+``make extract-phpdoc`` with the same ``ZETA_BASE`` path. This will also be
+done using ``make docs`` (see below).
+
+The tutorials
+-------------
+
+The tutorials are just copied from the zeta docs sections and made available on
+the website. This can be done by using ``make tutorials``. If you want to
+execute this for a specific release instead of trunk, pass a ``ZETA_BASE``
+environment variable to the script like shown above.
+
+Both, the extraction of the API documentation, and the copying of the tutorials
+is performed by ``make docs``.
+
+Content editing
+===============
+
+You can edit all the contents in the ``content/`` folder. Those are jsut ReST
+files. Be sure to call ``make website`` afterwards and commit the changes.
+Rebuilding the website might take some time.
+
+If you add new contents, remember to adapt the ``.index.xml`` in the respective
+directory accordingly.
+
+Writing news
+------------
+
+To write news, just create a new ReST file in ``content/news/``, following the
+naming scheme of existing blog posts, and reference it in
+``content/news/.blog.xml``. Remember to include an ``abstract`` or
+``description`` field list element, which defines the text occuring on the blog
+overview page.
+
+Releasing
+=========
+
+To rebuild everything for a release you probably want to execute the following
+commands::
+
+    # Building the API docs, requires lots of memory, maybe execute on a
+    # dedicated server.
+    ZETA_BASE=/path/to/zeta/2023.42 make -e phpdoc
+
+    # Extracting the new docs
+    ZETA_BASE=/path/to/zeta/2023.42 make -e docs
+
+    # Regenerating the HTML
+    make website
+
+    # Commit the new stuff
+    svn ci
+
+
+..
+   Local Variables:
+   mode: rst
+   fill-column: 79
+   End: 
+   vim: et syn=rst tw=79

Added: incubator/zetacomponents/website/structure.txt
URL: http://svn.apache.org/viewvc/incubator/zetacomponents/website/structure.txt?rev=981774&view=auto
==============================================================================
--- incubator/zetacomponents/website/structure.txt (added)
+++ incubator/zetacomponents/website/structure.txt Tue Aug  3 08:23:50 2010
@@ -0,0 +1,41 @@
+=================
+Website structure
+=================
+
+- About (shows news) (start page)
+  - Blog categories
+    - Entries
+- Community (how to contribute)
+  - Dev process
+  - Guidelines
+  - Ressources
+    - Presentations
+    - Articles
+- Documentation
+  - Installation
+  - Versions
+    - trunk
+      - …
+      - Graph
+        - Tutorial
+        - API docs
+        - Gallery
+        - …
+      - …
+    - 2010.1
+      - …
+- Download
+  - Old releases
+  - Logos
+- Support
+  - Contact forms
+  - Supporting companies
+  - Issue tracker
+
+
+..
+   Local Variables:
+   mode: rst
+   fill-column: 79
+   End: 
+   vim: et syn=rst tw=79



Mime
View raw message