Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/user18130814200115-2/groff-we-macros
groff-we macros is a fork of the groff-me macro set, modified for extra functionality and coherence
https://github.com/user18130814200115-2/groff-we-macros
groff groff-macro
Last synced: about 1 month ago
JSON representation
groff-we macros is a fork of the groff-me macro set, modified for extra functionality and coherence
- Host: GitHub
- URL: https://github.com/user18130814200115-2/groff-we-macros
- Owner: user18130814200115-2
- Created: 2021-03-27T15:56:29.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2021-06-07T15:18:25.000Z (over 3 years ago)
- Last Synced: 2024-08-03T17:12:33.618Z (5 months ago)
- Topics: groff, groff-macro
- Language: Roff
- Homepage:
- Size: 66.4 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# groff-me-macros
## Differences from groff-me
### Bullet points
Bulleted lists can be made with a call to
```
.bu
```
this command takes two agruments
```
.bu [CONTENTS] [DEPTH]
```
for instance, the following groff input
```
.bu "One"
.bu "Two"
.bu "Two A" 1
.bu "Two A Alpha" 2
```
produces the following output
- One
- Two
- Two A
- Two A Alpha
### Headings
A heading can be started with a call to
```
.uh
```
this command takes two arguments
```
.bu [CONTENTS] [DEPTH]
```
for instance, the following groff input
```
.uh "One"
.uh "Two"
.uh "Two A"
.uh "Two A Alpha"
```
produces the following output
# One
# Two
## Two A
### Two A Alpha
### Title Page
A title page can easily be created with two calls
```
.tt
.ta
```
both of these calls take two arguments
```
.tt "Title" "Subtitle"
.ta "Author" "Subtext"
```
The output will look like this
### Intext indents
The `.n` call can be used to make a tabbed indent at the start of the new line. This is useful for instance in writing dialogs.
```
John was astounded
.q "That is outrageous Mary!"
.n
.q "Not as outrageous as you may think"
.n
.q "Well I don't think we should go trough with it, think of the dangers!"
```
produces
```
John was astounded "That is outrageous Mary!"
"Not as outrageous as you may think"
"Well I don't think we should go trough with it, think of the dangers!"
```
### References
By default, when using refer with groff, the bibliography section at the end of a paper is called "References", written out in bold text.
In the we macro set, the heading is set as a chapter name using the call
```
.+c "References"
```
meaning that it will conform to the heading structure you set for chapters.
Furthermore, the call
```
.rh
```
can change the default title
```
.rh "Notes and Bibliography"
```
Will replace the "References" heading with "Notes and Bibliography"
Lastly, the fontsize of the bibliography section has been increased to 12 to be consistent with the other `.+c` sections in your documents.
### Bold and Italics
The calls `.b .i .r .rb .bi` now all accept a third argument. This third argument will be prepended to the text in the previous font.
Example
```
.b "This in bold" ) (
```
produces
(**This in bold**)
## Installation
Download both `we.tmac` and `refer-we.tmac` and install them to a groff accessible macro path such as `/usr/share/groff/current/tmac`.
The call groff with the `-mwe` option.
## Credit
Credit goes to to the University of California at Berkeley, Eric P. Allman and James Clark for making the original groff-me macros.