Difference between revisions of "User:Jholsenback"

From POV-Wiki
Jump to navigation Jump to search
 
(135 intermediate revisions by the same user not shown)
Line 1: Line 1:
−
==Intro==
+
===Organization===
−
I'm playing around with these LaTex markup files that are used in the POV-Ray documentation.
+
<p align="justify">
−
==Reference==
+
Basically, I've been using this area as a scratch pad of sorts. Old pages that I didn't want to loose track of are listed [[User:Jholsenback#Archives|here]] for easy access. </p>
−
These are in the reference section.
 
−
===blobdens===
 
−
<pre>
 
−
% FILE: blobdens
 
−
% --------
 
−
\begin{displaymath}
 
−
  \mathit{density} =
 
−
  \mathit{strength}\cdot
 
−
  \left(1-\left(\frac{\mathit{distance}}{\mathit{radius}}\right)^2\right)^2
 
−
\end{displaymath}
 
−
</pre>
 
−
Produces: <math>density = strength\cdot(1-(\frac {distance}{radius})^2)^2</math>
 
  
−
===curvmath===
+
===Scratch Pad===
−
<pre>
+
 
−
   % FILE: curvmath
+
====Syntax Diagram Examples====
−
% --------
+
<p>This is an example of the proposed format that's going to replace the pre-formatted text blocks which are currently being used, in the reference section narrative. Since there are some differences in the presentation of this construct in <em>html</em> and on <em>this documentation Wiki</em>, here's what you'll need to know.</p>
−
\begin{displaymath}
+
<ol>
−
   \begin{array}{l}
+
  <li>The syntax diagram is now inside a <strong>div</strong> tag instead of <strong>pre</strong> tag.</li>
−
    b = M \cdot x, \mathrm{with:}
+
   <li>The <strong>dt</strong> and <strong>dd</strong> elements of the list require that their ending tags be enclosed in the comments notation.</li>
−
    \\ \\
+
  <li>The first <strong>dt</strong> element that precedes the wiki link is required to properly align the link in the box.</li>
−
    b = \left[
+
  <li>Use underscores instead if spaces in the page address of the wiki link. The wiki parses to the first space to get the page address.</li>
−
      \begin{array}{c}
+
   <li>Please pick up the leading tabs when using copy and paste to maintain source readability when it's converted to html.</li>
−
        r(j)^2 \\
+
  <li>No edits or comments on this copy, go [[User_Talk:Jholsenback|here]] instead.</li>
−
        r(j+1)^2 \\
+
</ol>
−
        2 \cdot r(j) \cdot (r(j+1)-r(j-1)) \\
+
<p></p>
−
        \hline
+
<div class="Syntax">
−
        h(j+1)-h(j-1) \\
+
<dl>
−
        2 \cdot r(j+1) \cdot (r(j+2)-r(j)) \\
+
<dt><!--</dt>--->
−
        \hline
+
<dd class="Jump">[http://wiki.povray.org/content/Documentation:Reference_Section_3#Camera Go to documentation Wiki]<!--</dd>--->
−
        h(j+2)-h(j)
+
<dt>CAMERA:<!--</dt>--->
−
      \end{array}
+
<dd><code>camera {</code> [CAMERA_ITEMS...] <code>}</code><!--</dd>--->
−
    \right]
+
<dt>CAMERA_ITEMS:<!--</dt>--->
−
    \\ \\
+
<dd>CAMERA_TYPE | CAMERA_VECTOR | CAMERA_MODIFIER | CAMERA_IDENTIFIER<!--</dd>--->
−
    M = \left[
+
</dl>
−
      \begin{array}{c c c c}
+
</div>
−
        h(j)^3 & h(j)^2 & h(j) & 1 \\
+
====Reference Section Reorganization====
−
        h(j+1)^3 & h(j+1)^2 & h(j+1) & 1 \\
+
<p>Starting a new sub-section for notes ... </p>
−
        3\cdot h(j)^2 & 2\cdot h(j) & 1 & 0 \\
+
 
−
        3\cdot h(j+1)^2 & 2\cdot h(j+1) & 1 & 0
+
====Image Layout Templates====
−
      \end{array}
+
 
−
    \right]
+
<ul>
−
    \\ \\
+
  <li>single image narrative on the right with captions</li>
−
    x = \left[
+
</ul>
−
      \begin{array}{c}
+
 
−
        A(j)\\ B(j)\\ C(j)\\ D(j)
+
<table class="centered" width="700px" cellpadding="0" cellspacing="10">
−
      \end{array}
+
<tr>
−
    \right]
+
<td>
−
  \end{array}
+
[[Image:TutImgMediatut6.png|center|320px<!--left--->]]
−
\end{displaymath}
+
</td>
−
</pre>
+
<td>
−
===lattenua===
+
<p>As suggested previously, the scattering color and extinction values were adjusted until the image looked good. In this kind of scene usually very small values are needed.</p>
−
<pre>
+
 
−
% FILE: lattenua
+
<p>Note how the container box is quite smaller than the room itself. Container boxes should always be sized as minimally as possible. If the box were as big as the room much higher values for <code>samples</code> would be needed for a good result, thus resulting in a much slower rendering.</p>
−
% --------
+
</td>
−
\begin{displaymath}
+
</tr>
−
   \mathit{attenuation} =
+
<tr>
−
  \frac{2}
+
<td>
−
   {1+\left(\frac{d}{\mathit{fade\_distance}}\right)^\mathit{fade\_power}}
+
   <p class="caption">more advanced scattering media example</p>
−
\end{displaymath}
+
</td>
−
</pre>
+
<td>
−
===medatten===
+
</td>
−
<pre>
+
</tr>
−
% FILE: medatten
+
</table>
−
% --------
+
 
−
\begin{displaymath}
+
<ul>
−
   \mathit{attenuation} =
+
   <li>same as above only mirrored</li>
−
  \frac{1}
+
</ul>
−
   {1+\left(\frac{d}{\mathit{fade\_distance}}\right)^\mathit{fade\_power}}
+
 
−
\end{displaymath}
+
<table class="centered" width="700px" cellpadding="0" cellspacing="10">
−
</pre>
+
<tr>
−
===prod===
+
<td>
−
<pre>
+
<p>As suggested previously, the scattering color and extinction values were adjusted until the image looked good. In this kind of scene usually very small values are needed. </p>
−
% FILE: prod
+
 
−
% ----
+
<p>Note how the container box is quite smaller than the room itself. Container boxes should always be sized as minimally as possible. If the box were as big as the room much higher values for <code>samples</code> would be needed for a good result, thus resulting in a much slower rendering. </p>
−
\begin{displaymath}
+
</td>
−
   \prod_{i=b}^n a
+
<td >
−
\end{displaymath}
+
[[Image:TutImgMediatut6.png|center|320px<!--right--->]]
−
</pre>
+
</td>
−
Produces: <math>prod_{i=b}^n a</math>
+
</tr>
−
===sormath===
+
<tr>
−
<pre>
+
<td>
−
% sormath
+
</td>
−
% -------
+
<td>
−
\begin{displaymath}
+
   <p class="caption">more advanced scattering media example</p>
−
   r^2 = f(h) = A\cdot h^3 + B\cdot h^2 + C\cdot h + D
+
</td>
−
\end{displaymath}
+
</tr>
−
</pre>
+
</table>
−
Produces: <math>r^2 = f(h) = A\cdot h^3 + B\cdot h^2 + C\cdot h + D</math>
+
 
−
===sqemath===
+
<ul>
−
<pre>
+
   <li>panel of 3 with a border and captions</li>
−
% FILE: sqemath
+
</ul>
−
% -------
+
 
−
\begin{displaymath}
+
<table class="matte" width="700px" cellpadding="0" cellspacing="10">
−
  f(x,y,z) =
+
<tr>
−
  \left(|x|^{\left(\frac{2}{e}\right)} + |y|^{\left(\frac{2}{e}\right)}
+
  <td>
−
  \right)^{\left(\frac{e}{n}\right)} + |z|^{\left(\frac{2}{n}\right)} - 1 = 0
+
    [[Image:TutImgRadA01.png|center|220px<!--leftpanel--->]]
−
\end{displaymath}
+
  </td>
−
</pre>
+
   <td>
−
Produces: <math>f(x,y,z) = left(|x|^{\left(\frac{2}{e}\right)} + |y|^{\left(\frac{2}{e}\right)}right)^{\left(\frac{e}{n}\right)} + |z|^{\left(\frac{2}{n}\right)} - 1 = 0</math>
+
    [[Image:TutImgRadA03.png|center|220px<!--centerpanel--->]]
−
===sum===
+
  </td>
−
<pre>
+
  <td>
−
% FILE: sum
+
    [[Image:TutImgRadA0103.png|center|220px<!--rightpanel--->]]
−
% ---
+
  </td>
−
\begin{displaymath}
+
</tr>
−
  \sum_{i=b}^n a
+
<tr>
−
\end{displaymath}
+
   <td>
−
</pre>
+
    <p class="caption">no radiosity</p>
−
Produces: <math>sum_{i=b}^n a</math>
+
  </td>
 +
  <td>
 +
    <p class="caption">radiosity</p>
 +
  </td>
 +
  <td>
 +
    <p class="caption">difference w/o radiosity</p>
 +
  </td>
 +
</tr>
 +
</table>
 +
 
 +
====Keyword Addition Example====
 +
This outlines the steps to add a new keyword to the documentation. In this case <code>deprecated</code>
 +
 
 +
:* first determine where the [[Reference:Declare_and_Local_Directives#Deprecation_Support|descriptive passage]] goes then add it
 +
:* update the [[Reference:Declare_and_Local_Directives#Declaring_identifiers|syntax diagram]] in the appropriate places
 +
:* update the [[Reference:Keywords|Identifiers and Keywords]] list
 +
:* document any other [[Reference:Glass_old.inc|place(s)]] that it's used
 +
:* add a table of contents [[Documentation:Reference Table of Contents#Scene Description Language|entry]]
 +
 
 +
====NEW Template Test Area====
 +
<p>The {{New}} and {{Change}} templates can now be used inside a paragraph. See additional examples:</p>
 +
:*<p>This is a {{New}} feature as of version 3.7.1</p>
 +
:*<p>... and this is a {{Change}} in behavior as of version 3.7.0</p>
 +
<p>See also:</p>
 +
:*Usage in [[Reference:Numeric Expressions#Built-in Constants|tau]]
 +
:*also for the [[Reference:Torus|torus]] object
 +
 
 +
===Archives===
 +
:* Developers [[ Documentation:Developers_Notes|notes]] from when the Wiki-DocGen project started
 +
:* The source and notes on the [[Documentation:LaTex_Files|LaTeX]] markup used in the documentation
 +
:* The change-log has been reviewed and the results are [[Documentation:ToDo ChangeListReview|here]]
 +
:* <p>Some text here just <span class="formula">f(x) = x&#770;&#915;</span> for comparison.</p>
 +
:* Some <em>wiki-docgen</em> process [[User:Jholsenback/WikiDocGen|notes]]

Latest revision as of 07:19, 18 September 2019

Organization

Basically, I've been using this area as a scratch pad of sorts. Old pages that I didn't want to loose track of are listed here for easy access.

Scratch Pad

Syntax Diagram Examples

This is an example of the proposed format that's going to replace the pre-formatted text blocks which are currently being used, in the reference section narrative. Since there are some differences in the presentation of this construct in html and on this documentation Wiki, here's what you'll need to know.

  1. The syntax diagram is now inside a div tag instead of pre tag.
  2. The dt and dd elements of the list require that their ending tags be enclosed in the comments notation.
  3. The first dt element that precedes the wiki link is required to properly align the link in the box.
  4. Use underscores instead if spaces in the page address of the wiki link. The wiki parses to the first space to get the page address.
  5. Please pick up the leading tabs when using copy and paste to maintain source readability when it's converted to html.
  6. No edits or comments on this copy, go here instead.

Go to documentation Wiki
CAMERA:
camera { [CAMERA_ITEMS...] }
CAMERA_ITEMS:
CAMERA_TYPE | CAMERA_VECTOR | CAMERA_MODIFIER | CAMERA_IDENTIFIER

Reference Section Reorganization

Starting a new sub-section for notes ...

Image Layout Templates

  • single image narrative on the right with captions
TutImgMediatut6.png

As suggested previously, the scattering color and extinction values were adjusted until the image looked good. In this kind of scene usually very small values are needed.

Note how the container box is quite smaller than the room itself. Container boxes should always be sized as minimally as possible. If the box were as big as the room much higher values for samples would be needed for a good result, thus resulting in a much slower rendering.

more advanced scattering media example
  • same as above only mirrored

As suggested previously, the scattering color and extinction values were adjusted until the image looked good. In this kind of scene usually very small values are needed.

Note how the container box is quite smaller than the room itself. Container boxes should always be sized as minimally as possible. If the box were as big as the room much higher values for samples would be needed for a good result, thus resulting in a much slower rendering.

TutImgMediatut6.png

more advanced scattering media example
  • panel of 3 with a border and captions
TutImgRadA01.png
TutImgRadA03.png
TutImgRadA0103.png

no radiosity

radiosity

difference w/o radiosity

Keyword Addition Example

This outlines the steps to add a new keyword to the documentation. In this case deprecated

NEW Template Test Area

The New and Change templates can now be used inside a paragraph. See additional examples:

  • This is a New feature as of version 3.7.1

  • ... and this is a Change in behavior as of version 3.7.0

See also:

Archives

  • Developers notes from when the Wiki-DocGen project started
  • The source and notes on the LaTeX markup used in the documentation
  • The change-log has been reviewed and the results are here

  • Some text here just f(x) = x̂Γ for comparison.

  • Some wiki-docgen process notes
Retrieved from "https://wiki.povray.org/content?title=User:Jholsenback&oldid=9703"