Author: cbrisson Date: Tue Jun 26 12:13:08 2018 New Revision: 1834421 URL: http://svn.apache.org/viewvc?rev=1834421&view=rev Log: [site] Supress redundant README and update site building page => prod
Removed: velocity/site/production/README Modified: velocity/site/production/css/site.css velocity/site/production/site-building.html Modified: velocity/site/production/css/site.css URL: http://svn.apache.org/viewvc/velocity/site/production/css/site.css?rev=1834421&r1=1834420&r2=1834421&view=diff ============================================================================== --- velocity/site/production/css/site.css (original) +++ velocity/site/production/css/site.css Tue Jun 26 12:13:08 2018 @@ -278,6 +278,13 @@ pre, code padding: 3px 3px; } +.grayed +{ + color: darkgray; + font-style: italic; + text-decoration: strike-though; +} + /* tables */ table.standard, table.table Modified: velocity/site/production/site-building.html URL: http://svn.apache.org/viewvc/velocity/site/production/site-building.html?rev=1834421&r1=1834420&r2=1834421&view=diff ============================================================================== --- velocity/site/production/site-building.html (original) +++ velocity/site/production/site-building.html Tue Jun 26 12:13:08 2018 @@ -225,7 +225,26 @@ h2:hover > .headerlink, h3:hover > .head } h2:hover > .headerlink, h3:hover > .headerlink, h1:hover > .headerlink, h6:hover > .headerlink, h4:hover > .headerlink, h5:hover > .headerlink, dt:hover > .elementid-permalink { visibility: visible }</style> <h2 id="the-apache-velocity-site">the Apache Velocity Site<a class="headerlink" href="#the-apache-velocity-site" title="Permanent link">¶</a></h2> -<p>WARNING! This document might be out of date! For the latest information on how to build the Apache Velocity Site, please check out the actual <a href="/README">README</a> file which contains the latest information. This document has been created from the README and is not updated as often.</p> +<div class="toc"> +<ul> +<li><a href="#the-apache-velocity-site">the Apache Velocity Site</a><ul> +<li><a href="#introduction">Introduction</a></li> +<li><a href="#editing-the-site">Editing the Site</a></li> +<li><a href="#building-the-site">Building the Site</a></li> +<li><a href="#additional-notes">Additional Notes</a><ul> +<li><a href="#table-of-content">Table of Content</a></li> +<li><a href="#tables">Tables</a></li> +<li><a href="#syntax-highlighting">Syntax highlighting</a></li> +<li><a href="#breadcrumbs">Breadcrumbs</a></li> +<li><a href="#left-navigation">Left Navigation</a></li> +<li><a href="#post-processing">Post-Processing</a></li> +</ul> +</li> +</ul> +</li> +<li><a href="#todo">TODO</a></li> +</ul> +</div> <h3 id="introduction">Introduction<a class="headerlink" href="#introduction" title="Permanent link">¶</a></h3> <p>The Apache Velocity Site is what you get when you visit <a href="/">our homepage</a>. It is the envelope site for all Apache Velocity sub projects.</p> <p>In short: This svn repository is only interesting for you if you</p> @@ -236,11 +255,16 @@ h2:hover > .headerlink, h3:hover > .head <h3 id="editing-the-site">Editing the Site<a class="headerlink" href="#editing-the-site" title="Permanent link">¶</a></h3> <p>Apache Velocity uses the <a href="http://www.apache.org/dev/cms.html">Apache Content Management System</a> to manage its site.</p> <p>For the time being, the site is not yet <em>hosted</em> by the CMS (which is not yet accepting new sites before undergoing a machine transition), so the site still has to be build locally. Please refer to the next section. The rest of this section is <em>not yet applicable</em>.</p> -<p>To just edit one page, all you need is the bookmarklet found <a href="https://cms.apache.org/#bookmark">here</a></p> -<p>If you're a commiter, you'll be able to push your edits by yourself on the production site. Otherwise, the CMS will let you generate a diff file that you can <a href="/contact.html">send to the devs</a>.</p> -<p>Commiters can also commit changes to <a href="http://svn.apache.org/repos/asf/velocity/site/cms/trunk/">the site under svn</a> and trigger a publication in production from the CMS.</p> +<p class="grayed">To just edit one page, all you need is the bookmarklet found <a href="https://cms.apache.org/#bookmark">here</a> +</p> +<p class="grayed">If you're a commiter, you'll be able to push your edits by yourself on the production site. Otherwise, the CMS will let you generate a diff file that you can <a href="/contact.html">send to the devs</a>. +</p> +<p class="grayed">Commiters can also commit changes to <a href="http://svn.apache.org/repos/asf/velocity/site/cms/trunk/">the site under svn</a> and trigger a publication in production from the CMS. +</p> <h3 id="building-the-site">Building the Site<a class="headerlink" href="#building-the-site" title="Permanent link">¶</a></h3> -<p>To build the site locally, you'll need a local checkout of the <a href="https://svn.apache.org/repos/infra/websites/cms">Apache CMS</a> (check the <a href="https://svn.apache.org/repos/infra/websites/cms/STATUS">STATUS</a> file) and of course a local checkout of <a href="https://svn.apache.org/repos/asf/velocity/site">Velocity's site sources</a>.</p> +<p>To build the site locally, you'll need a local checkout of the <a href="https://svn.apache.org/repos/infra/websites/cms">Apache CMS</a>, then refer to the <a href="https://svn.apache.org/repos/infra/websites/cms/STATUS">STATUS</a> file. +You'll of course also need a local checkout of <a href="https://svn.apache.org/repos/asf/velocity/site">the site sources</a> (the sources for the cms are in /cms/, but the process needs the whole site).</p> +<p>While Velocity isn't yet hosted on the CMS, you'll have to generate the site in velocity/site/production, then check added/modified/deleted files with <code>svn status</code>, and commit the result.</p> <p>Typically, you'll have to:</p> <ol> <li>define the environment variable MARKDOWN_SOCKET to something like /tmp/markdown</li> @@ -288,7 +312,32 @@ svn status <span class="nv">$VELOCITY</s </pre></div> </td></tr></table> +<p>Notes:</p> +<ul> +<li>the markdown tables extension, in the python-markdown package (python 2.7), seems broken at version 2.6.9 ; I had to revert the markdown package to 2.6.7.</li> +<li>the python pygments lexer (used by markdown/codehilite for code syntax highlighting) knows about the Velocity syntax, but not about silent references like <code>$!foo</code> or <code>$!{bar}</code>. I patched it and sent the <a href="https://bitbucket.org/birkenfeld/pygments-main/pull-requests/771/add-velocity-silent-references-syntax/diff">patch</a> upstream.</li> +</ul> <h3 id="additional-notes">Additional Notes<a class="headerlink" href="#additional-notes" title="Permanent link">¶</a></h3> +<h4 id="table-of-content">Table of Content<a class="headerlink" href="#table-of-content" title="Permanent link">¶</a></h4> +<p>Per-page table of contents can be displayed with the following placeholder:</p> +<div class="codehilite"><pre>[TOC] +</pre></div> + + +<h4 id="tables">Tables<a class="headerlink" href="#tables" title="Permanent link">¶</a></h4> +<p>Tables are supported. See the documentation of the <a href="https://python-markdown.github.io/extensions/tables/">python-markdown</a> extension.</p> +<h4 id="syntax-highlighting">Syntax highlighting<a class="headerlink" href="#syntax-highlighting" title="Permanent link">¶</a></h4> +<p>The markdown module used by the CMS allows one to specify which language lexer to use for syntax coloring of blocks of code, using the following syntax:</p> +<p>:::velocity<br /> + #set( $foo = 'bar' )<br /> + ...</p> +<p>which produces:</p> +<div class="codehilite"><pre><span class="cp">#</span><span class="nf">set</span><span class="p">(</span> <span class="p">$</span><span class="nv">foo</span> <span class="o">=</span> <span class="s1">'bar'</span> <span class="p">)</span><span class="x"></span> +<span class="x"> ...</span> +</pre></div> + + +<p>There are many lexers available, among which :::java, :::html, :::xml, :::properties, :::velocity, :::html+velocity, :::xml+velocity, etc.</p> <h4 id="breadcrumbs">Breadcrumbs<a class="headerlink" href="#breadcrumbs" title="Permanent link">¶</a></h4> <p>Breadcrumbs use the full pathname of the file (one path per level). So choose filenames and structure apropriately, as directory names will be used to label each step.</p> <h4 id="left-navigation">Left Navigation<a class="headerlink" href="#left-navigation" title="Permanent link">¶</a></h4>