Skip to content

Commit

Permalink
Update the text help patch with information about rich text formatting.
Browse files Browse the repository at this point in the history
  • Loading branch information
agraef committed Sep 27, 2024
1 parent effa95a commit ccd5b31
Show file tree
Hide file tree
Showing 2 changed files with 37 additions and 11 deletions.
22 changes: 22 additions & 0 deletions pd/doc/5.reference/all_about_rich_text.pd
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
#N canvas 774 239 512 642 12;
#X text 20 10 <h>Rich Text Formatting</h> <#090><b>This</b> <#f69>is</#f69>
<s>normal</s> <#039><u>rich</u> <#909>text</#909>. This <i>only</i>
works in comments \, and uses special tags in the input text. Tags
come in pairs \, as they do in HTML \, '<!tag>' begins and '<!/tag>'
ends a specially formatted part of the text. Currently supported tags
are: • <!h><h>header text</h><!/h>   Typeset in bold at 120% size. •
<!b><b>bold text</b><!/b> • <!i><i>italic text</i><!/i> • <!u><u>underlined
text</u><!/u> • <!s><s>strike-through text</s><!/s> • <!red><red>colored
text</red><!/red>   The standard HTML color names and triplets can
be used as tags. Obviously \, this won't replace your word processor
anytime soon \, and entering all the formatting tags can get a bit
tedious. But at least it provides you with some useful formatting options. <b>NOTE:</b>
This entire text is in a single comment object \, so you can click
on this object in edit mode to reveal how it was formatted. To show
a tag as a literal in a comment \, as we did in the descriptions above
\, it can be escaped with a '!' immediately following the angle bracket
\, e.g.: '<!!tag>'. Please also note that none of the formatting tags
will work in vanilla Pd at present \, instead you will see the text
as shown while editing the comment box. Which doesn't look great \,
TBH \, thus rich text formatting is best avoided in patches that you
plan to use with vanilla Pd. , f 66;
26 changes: 15 additions & 11 deletions pd/doc/5.reference/text-help.pd
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
#N canvas 372 200 555 619 10;
#N canvas 373 200 555 619 10;
#X obj 0 595 cnv 15 552 21 empty \$0-pddp.cnv.footer empty 20 12 0
14 #dcdcdc #404040 0;
#X obj 0 0 cnv 15 552 40 empty \$0-pddp.cnv.header text 3 12 0 18 #c4dcdc
Expand Down Expand Up @@ -66,23 +66,27 @@ float atom and you will lose some rather important precision!;
#X obj 99 571 pddp/pddplink all_about_ascii_art.pd;
#X text 378 11 To create \, click <Control-5>;
#X text 11 23 box with text for an object or comment;
#X text 40 127 Comments don't actually "do" anything \, but you can
#X text 40 107 Comments don't actually "do" anything \, but you can
use them to annotate your patch \, explain how something works \, add
a copyright notice \, or anything else., f 76;
#X text 40 80 All text in Pure Data is just a series of symbol and/or
#X text 40 60 All text in Pure Data is just a series of symbol and/or
float atoms. You create Pd objects by typing text into an object box
\, but you can also write text as a comment for your patch (like this
one)., f 76;
#X text 40 174 To create a comment \, use the "Put" menu or click <Control-5>.
#X text 40 154 To create a comment \, use the "Put" menu or click <Control-5>.
, f 76;
#X obj 300 575 pddp/pddplink all_about_rich_text.pd;
#X text 40 400 For some other peculiarities with Pd's comments please
check the "Some Comments on Comments" subpatch below., f 76;
#X text 40 330 NOTE: Visual formatting of comments is a Purr Data-specific
feature \, it will *not* work (and look funny) in vanilla Pd! Thus
you want to avoid it in patches that are to be run in both environments.
, f 76;
#X text 40 210 Purr Data also lets you do visual formatting of comments
check the <b>"Some Comments on Comments"</b> subpatch below., f 76
;
#X text 40 190 Purr Data also lets you do visual formatting of comments
using explicit line breaks. E.g: Lorem ipsum dolor sit amet \, consetetur
sadipscing elitr \, sed diam nonumy eirmod tempor invidunt ut labore et
dolore magna aliquyam erat \, sed diam voluptua. At vero eos et accusam
et justo duo dolores et ea rebum., f 76;
et justo duo dolores et ea rebum. There are also some possibilities
for <red><b>rich text formatting</b></red> \, please see the <b>"all_about_rich_text"</b>
patch linked below for details., f 76;
#X text 40 350 <b>NOTE:</b> Visual and rich text formatting of comments
are Purr Data-specific features \, they will *not* work (and look funny)
in vanilla Pd! Thus they're best avoided in patches that are to be
run in both environments., f 76;

0 comments on commit ccd5b31

Please sign in to comment.