Difference between revisions of "Paragraph Referencing"

From Wiki
Jump to navigation Jump to search
m
m
 
(15 intermediate revisions by 3 users not shown)
Line 1: Line 1:
<div style="color: red">Page in progress</div>
+
(This module is currently not in die distribution. Until it is, you can download it from [http://zenlima.com/context/t-pararef-0.8.2.zip here]).
  
This module understands a paragraph as a full closed block of one thought. This means that inside a paragraph enumerations, formulas etc. can apear. That is why a paragraph must be defined manuelly via <code>\startParagraph</code> and <code>\stopParagraph</code>.
+
The [https://modules.contextgarden.net/cgi-bin/module.cgi/ruid=1253027735/action=view/id=64 pararef] module understands a paragraph as a full closed block of one thought. This means that inside a paragraph enumerations, formulas etc. can appear. That is why a paragraph must be defined manually via <code>\startParagraph</code> and <code>\stopParagraph</code>.
 +
 
 +
==Paragraphs==
  
 
Each paragraph gets numbered started by each title. In order to link to a paragraph it can be reference by the optional parameter <code>reference=...</code> as a text reference.
 
Each paragraph gets numbered started by each title. In order to link to a paragraph it can be reference by the optional parameter <code>reference=...</code> as a text reference.
Line 13: Line 15:
 
</texcode>
 
</texcode>
  
<div style="background: #FFFFDD">Singe paragraph: code and result</div>
+
Here how a single paragraph with a title looks like:
  
 
<texcode>
 
<texcode>
Line 25: Line 27:
 
</texcode>
 
</texcode>
  
<div style="background: #FFFFDD">Multi paragraphs and references: code and result</div>
+
[[Image:t-pararef-1.jpg]]
 +
 
 +
 
 +
==References==
 +
 
 +
Now the more practical part: the paragraph referencing. To reference to an paragraph the package pararef makes use of the [[Cross Referencing|crossref]] module.
 +
 
 +
Here a simple usage example:
 +
 
 +
<texcode>
 +
\usemodule[pararef]
 +
\usemodule[crossref]
 +
 
 +
\starttext
 +
 
 +
\startchapter[title={Lorem ipsum}]
 +
\startsection[title={Dolor sit}]
 +
 
 +
\startParagraph
 +
\input tufte
 +
\stopParagraph
 +
 
 +
\startParagraph[reference=ref1]
 +
\input tufte
 +
\stopParagraph
 +
 
 +
\startParagraph
 +
Here are two references to destinations on the same page:
 +
\startitemize[nowhite]
 +
\item ref1 should be: para. 1.1/2 and is: \crossref[label={para.}][ref1]
 +
\item ref2 should be: sec. 1.2 and is: \crossref[label={sec.}][ref2]
 +
\stopitemize
 +
Here is one references with brakets:
 +
\startitemize[nowhite]
 +
\item ref1 should be: (para. 1.1/2) and is: \crossref[left={(},right={)},label={para.}][ref1]
 +
\stopitemize
 +
\stopParagraph
 +
 
 +
\stopsection
 +
\startsection[title={Amet},reference=ref2]
 +
 
 +
\page
 +
 
 +
\startParagraph
 +
Here are two references to destinations on an other page:
 +
\startitemize[nowhite]
 +
\item ref1 should be: para. 1.1/2 on page 1 and is: \crossref[label={para.}][ref1]
 +
\item ref2 should be: sec. 1.2 on page 1 and is: \crossref[label={sec.}][ref2]
 +
\stopitemize
 +
\stopParagraph
 +
 
 +
\stopsection
 +
\stopchapter
 +
\stoptext
 +
</texcode>
 +
 
 +
[[File:t-pararef-2.jpg]]
 +
[[File:t-pararef-3.jpg]]
 +
 
 +
==Text part divider==
 +
 
 +
Each section (subsection, subsubsection etc.) has mostly three parts:
 +
* introduction part,
 +
* one or several main parts and
 +
* summary part.
 +
Each part contains one or more paragraphs. To make the logic parts visible the parts are divided by a line <code>\textpartdivider</code>.
 +
 
 +
<texcode>
 +
\usemodule[pararef]
 +
 
 +
\starttext
 +
 
 +
\startsection[title={Lorem ipsum}]
 +
\startParagraph
 +
Some introduction text \input tufte
 +
\stopParagraph
 +
 
 +
\textpartdivider
 +
 
 +
\dorecurse{3}{
 +
\startParagraph
 +
Some main theme text \input tufte
 +
\stopParagraph
 +
}
 +
 
 +
\textpartdivider
 +
 
 +
\startParagraph
 +
Some section summarizing text \input tufte
 +
\stopParagraph
 +
 
 +
\stopsection
 +
\startsection[title={Doloris sit}]
 +
...
 +
\stopsection
 +
\stoptext
 +
</texcode>
 +
 
 +
[[File:t-pararef-4.jpg]]
 +
 
 +
==Settings==
 +
 
 +
In pararef the colors can be set via two paramters:
 +
* <code>textpartdividerColor</code> for the color of the line and
 +
* <code>paragraphNumberColor</code> for the number of the paragraph.
 +
 
 +
They are defined as parameters of the module:
 +
<texcode>
 +
\usemodule[pararef][textpartdividerColor=...,paragraphNumberColor=...]
 +
...
 +
</texcode>
 +
 
 +
For now the color and style of the paragraph title has to be set via the normal outer margin settings.
 +
 
 +
[[Category:Basics]]

Latest revision as of 15:10, 8 June 2020

(This module is currently not in die distribution. Until it is, you can download it from here).

The pararef module understands a paragraph as a full closed block of one thought. This means that inside a paragraph enumerations, formulas etc. can appear. That is why a paragraph must be defined manually via \startParagraph and \stopParagraph.

Paragraphs

Each paragraph gets numbered started by each title. In order to link to a paragraph it can be reference by the optional parameter reference=... as a text reference.

One or more paragraphs can be summarized by a low level title which is displayed as a margin note (margin title) via the optional parameter title=....

 \startParagraph[reference=...,title=...]
 ...
 \stopParagraph

Here how a single paragraph with a title looks like:

\usemodule[pararef]

\starttext
\startParagraph[title={Paragraph heading}]
\input tufte
\stopParagraph
\stoptext

t-pararef-1.jpg


References

Now the more practical part: the paragraph referencing. To reference to an paragraph the package pararef makes use of the crossref module.

Here a simple usage example:

\usemodule[pararef]
\usemodule[crossref]

\starttext

\startchapter[title={Lorem ipsum}]
\startsection[title={Dolor sit}]

\startParagraph
\input tufte 
\stopParagraph

\startParagraph[reference=ref1]
\input tufte 
\stopParagraph

\startParagraph
Here are two references to destinations on the same page:
\startitemize[nowhite]
\item ref1 should be: para. 1.1/2 and is: \crossref[label={para.}][ref1]
\item ref2 should be: sec. 1.2 and is: \crossref[label={sec.}][ref2]
\stopitemize
Here is one references with brakets:
\startitemize[nowhite]
\item ref1 should be: (para. 1.1/2) and is: \crossref[left={(},right={)},label={para.}][ref1]
\stopitemize
\stopParagraph

\stopsection
\startsection[title={Amet},reference=ref2]

\page

\startParagraph
Here are two references to destinations on an other page:
\startitemize[nowhite]
\item ref1 should be: para. 1.1/2 on page 1 and is: \crossref[label={para.}][ref1]
\item ref2 should be: sec. 1.2 on page 1 and is: \crossref[label={sec.}][ref2]
\stopitemize
\stopParagraph

\stopsection
\stopchapter
\stoptext

t-pararef-2.jpg t-pararef-3.jpg

Text part divider

Each section (subsection, subsubsection etc.) has mostly three parts:

  • introduction part,
  • one or several main parts and
  • summary part.

Each part contains one or more paragraphs. To make the logic parts visible the parts are divided by a line \textpartdivider.

\usemodule[pararef]

\starttext

\startsection[title={Lorem ipsum}]
\startParagraph
Some introduction text \input tufte
\stopParagraph

\textpartdivider

\dorecurse{3}{
\startParagraph
Some main theme text \input tufte
\stopParagraph
}

\textpartdivider

\startParagraph
Some section summarizing text \input tufte
\stopParagraph

\stopsection
\startsection[title={Doloris sit}]
...
\stopsection
\stoptext

t-pararef-4.jpg

Settings

In pararef the colors can be set via two paramters:

  • textpartdividerColor for the color of the line and
  • paragraphNumberColor for the number of the paragraph.

They are defined as parameters of the module:

\usemodule[pararef][textpartdividerColor=...,paragraphNumberColor=...]
...

For now the color and style of the paragraph title has to be set via the normal outer margin settings.