@recaptime-dev's working patches + fork for Phorge, a community fork of Phabricator. (Upstream dev and stable branches are at upstream/main and upstream/stable respectively.)
hq.recaptime.dev/wiki/Phorge
phorge
phabricator
Add documentation for cowsay
Summary:
Cowsay is great, but what if you want to talk like a koala?
This diff adds diviner documentation on how to use the additional templates in externals/cowsay/cows/
Test Plan:
bin/diviner generate
https://my.phorge.site/book/phorge/article/differential_cowsay/
Reviewers: O1 Blessed Committers, valerio.bozzolan
Reviewed By: O1 Blessed Committers, valerio.bozzolan
Subscribers: tobiaswiese, valerio.bozzolan, Matthew, Cigaryno
Differential Revision: https://we.phorge.it/D25434
+73
-2
+1
src/docs/user/userguide/differential.diviner
+1
src/docs/user/userguide/differential.diviner
···
66
66
- diving into the details of inline comments in
67
67
@{article:Differential User Guide: Inline Comments}; or
68
68
- reading the FAQ at @{article:Differential User Guide: FAQ}; or
69
+
- learning how to use markup in comments at @{article:Remarkup Reference}; or
69
70
- learning about test plans in
70
71
@{article:Differential User Guide: Test Plans}; or
71
72
- learning more about Herald in @{article:Herald User Guide}.
+7
-2
src/docs/user/userguide/differential_faq.diviner
+7
-2
src/docs/user/userguide/differential_faq.diviner
···
41
41
42
42
If authors are being jerks about this (making sweeping changes as soon as they
43
43
get an accept), solve the problem socially by telling them to stop being jerks.
44
-
Unless you've configured additional layers of enforcement, there's nothing
45
-
stopping them from silently changing the code before pushing it, anyway.
44
+
Unless you've configured additional layers of enforcement (by
45
+
using @{article:Herald}), there's nothing stopping them from silently changing
46
+
the code before pushing it, anyway.
46
47
47
48
48
49
= How can I enable syntax highlighting? =
···
50
51
You need to install and configure **Pygments** to highlight anything else than
51
52
PHP. See the `pygments.enabled` configuration setting.
52
53
54
+
= What formatting can be used in comments? =
55
+
56
+
Phorge implements a markup language similar to other markup languages like
57
+
Markdown and Wiki markup. See @{article:Remarkup Reference}.
53
58
54
59
= What do the very light green and red backgrounds mean? =
55
60
+4
src/docs/user/userguide/remarkup.diviner
+4
src/docs/user/userguide/remarkup.diviner
···
732
732
Remarkup editors provide a fullscreen composition mode. This can make it easier
733
733
to edit large blocks of text, or improve focus by removing distractions. You can
734
734
exit **Fullscreen** mode by clicking the button again or by pressing escape.
735
+
736
+
See Also
737
+
========
738
+
* @{article:Remarkup Reference: Cowsay}
+61
src/docs/user/userguide/remarkup_cowsay.diviner
+61
src/docs/user/userguide/remarkup_cowsay.diviner
···
1
+
@title Remarkup Reference: Cowsay
2
+
@group userguide
3
+
4
+
Overview
5
+
--------
6
+
7
+
Cowsay is an application by Tony Monroe which has been ported over to
8
+
Phabricator/Phorge to allow your comments to be voiced by
9
+
a cow.
10
+
11
+
Basic Usage
12
+
-----------
13
+
14
+
A basic example of using cowsay would be to add a comment
15
+
cowsay{{{Great work!}}}
16
+
which generates:
17
+
```
18
+
_____________
19
+
< Great work! >
20
+
-------------
21
+
\ ^__^
22
+
\ (oo)\_______
23
+
(__)\ )\/\
24
+
||----w |
25
+
|| ||
26
+
```
27
+
28
+
Other Cowsay Templates
29
+
----------------------
30
+
Other templates are available in externals/cowsay/cows/, and you can specify
31
+
one by calling cowsay with the 'cow' parameter. eg:
32
+
cowsay(cow='tux'){{{Great work!}}}
33
+
generates
34
+
```
35
+
_____________
36
+
< Great work! >
37
+
-------------
38
+
\
39
+
\
40
+
.--.
41
+
|o_o |
42
+
|:_/ |
43
+
// \ \
44
+
(| | )
45
+
/'\_ _/`\
46
+
\___)=(___/
47
+
```
48
+
49
+
Other Parameters
50
+
----------------
51
+
* think (set to 1 for thinking bubbles)
52
+
* eyes (default 'oo')
53
+
* tongue (default ' ', try 'P')
54
+
55
+
See Also
56
+
========
57
+
* @{article:Remarkup Reference}
58
+
* Have you tried figlet:
59
+
```
60
+
figlet{{{figlet generates big text!}}}
61
+
```