Giter Club home page Giter Club logo

groff-we-macros's Introduction

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

example of .tt and .ta calls

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.

groff-we-macros's People

Contributors

user18130814200115-2 avatar

Stargazers

 avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.