commit: 0e541e5d3137d213038256d40cfac6c5c273fd55
parent: 173e1a2f5a80cdc81dd55c925c0bec6317995e39
author: Chris Noxz <chris@noxz.tech>
date: Tue, 16 Aug 2022 10:09:13 +0200
add semi-new articles that previously resided under guides
46 files changed, 133 insertions(+), 203 deletions(-)
diff --git a/noxz.tech/guides/.assemble b/noxz.tech/articles/crossing_out_expressions_in_eqn/.assemble
rename noxz.tech/guides/.assemble → noxz.tech/articles/crossing_out_expressions_in_eqn/.assemble
diff --git a/noxz.tech/guides/groff/papers/.buildignore b/noxz.tech/articles/crossing_out_expressions_in_eqn/.buildignore
rename noxz.tech/guides/groff/papers/.buildignore → noxz.tech/articles/crossing_out_expressions_in_eqn/.buildignore
diff --git a/noxz.tech/articles/crossing_out_expressions_in_eqn/.metadata b/noxz.tech/articles/crossing_out_expressions_in_eqn/.metadata
@@ -0,0 +1,5 @@
+.ds YEAR 2019
+.ds MONTH October
+.ds DAY 29
+.ds DATE \*[MONTH] \*[DAY], \*[YEAR]
+.ds TITLE Crossing out expressions in eqn
diff --git a/noxz.tech/articles/crossing_out_expressions_in_eqn/index.www b/noxz.tech/articles/crossing_out_expressions_in_eqn/index.www
@@ -0,0 +1,43 @@
+You can read about defining a macro for canceling an expression in the
+.I man
+page of
+.I eqn .
+This macro draws a line over the expression, as an indication that it’s
+canceled. When using paper and pen, I usually use a cross instead, so this is
+how you do the same in
+.I eqn .
+
+.CDS
+.COS
+\&.\\" define cancel_cross macro for expressions
+\&.defcolor cancelcolor rgb 0.0f 0.0f 0.0f
+\&.EQ }
+define cancel_cross 'special Cax'
+\&.EN
+\&.de Cax
+\&. ds 0s \\
+\\Z'\\\\*(0s'\\
+\\Z'\\D't 0.75p''\\
+\\m[cancelcolor]\\
+\\v'\\\\n(0du'\\
+\\D'l \\\\n(0wu -\\\\n(0hu-\\\\n(0du'\\
+\\h'-\\\\n(0wu'\\
+\\D'l \\\\n(0wu \\\\n(0hu+\\\\n(0du'\\
+\\v'-\\\\n(0hu-\\\\n(0du'\\
+\\Z'\\D't 0.5p''\\
+\\m[default]\\
+\\v'\\\\n(0hu'
+\&..
+.COE
+.CDE
+
+Then use it, for example, like this:
+.ICD "{ 4 times 1 } over { 4 times 5 } = { cancel_cross 4 times 1 } over { cancel_cross 4 times 5 }" .
+
+You can, of course, name your macro
+.ICD cancel
+instead of
+.ICD cancel_cross .
+The
+.ICD cancelcolor
+is also optional, and in the case above, redundant.
diff --git a/noxz.tech/guides/groff/.assemble b/noxz.tech/articles/sic_collection_of_papers_on_troff_and_its_companions/.assemble
rename noxz.tech/guides/groff/.assemble → noxz.tech/articles/sic_collection_of_papers_on_troff_and_its_companions/.assemble
diff --git a/noxz.tech/articles/sic_collection_of_papers_on_troff_and_its_companions/.buildignore b/noxz.tech/articles/sic_collection_of_papers_on_troff_and_its_companions/.buildignore
diff --git a/noxz.tech/articles/sic_collection_of_papers_on_troff_and_its_companions/.metadata b/noxz.tech/articles/sic_collection_of_papers_on_troff_and_its_companions/.metadata
@@ -0,0 +1,5 @@
+.ds YEAR 2019
+.ds MONTH October
+.ds DAY 16
+.ds DATE \*[MONTH] \*[DAY], \*[YEAR]
+.ds TITLE SiC: Collection of papers on troff and its companions
diff --git a/noxz.tech/guides/groff/index.www b/noxz.tech/articles/sic_collection_of_papers_on_troff_and_its_companions/index.www
rename noxz.tech/guides/groff/index.www → noxz.tech/articles/sic_collection_of_papers_on_troff_and_its_companions/index.www
@@ -1,31 +1,10 @@
-As these guides are created for
-.I groff ,
-I cannot guarantee that they are applicable to
-.I troff .
-If you use
-.I troff
-and can confirm them to work for it \(en please let me know.
-
-Apart from
-.I groff ,
-these guides may include other programs used together with
-.I groff ,
-such as
-.I eqn ,
-.I tbl ,
-and so on. I will try to make this clear in the description of each guide.
-
-.HnS 1
-Collection of papers on troff and its companions
-.HnE
-
-Following is a collection based on
+The following is a collection based on
.URL "https://www.troff.org/papers.html" "troff.org/papers" .
-However, I found that much of the links referenced from that site are dead. I
-have instead downloaded and compiled pdfs from archive.org. Much of the material
-available was written at Bell Labs. The CSTR documents below refer to 'Computer
-Science Technical Reports', a Bell Labs internal numbering system used in the
-past.
+However, I found that many of the links referenced on that site are dead. I
+have instead downloaded and compiled pdfs from archive.org. Much of the
+material available was written at Bell Labs. The CSTR documents below refer to
+"Computer Science Technical Reports", a Bell Labs internal numbering system
+used in the past.
.HnS 2
troff
@@ -169,97 +148,3 @@ CSTR #128, J. L. Bentley and
.URL "https://www.troff.org/whoswho.html#bwk" "B. W. Kernighan" ,
Bell Labs, October 1986.
.ULE
-
-.HnS 1
-Crossing out expressions in
-.I eqn
-.HnE
-
-In the
-.I man
-page of
-.I eqn
-you can read about defining a macro for canceling an expression. This macro
-draws a line over the expression, as an indication it's canceled. When using
-paper and pen I usually use a cross instead, so this is how you do the same in
-.I eqn.
-
-.CDS
-.COS
-\&.\\" define cancel_cross macro for expressions
-\&.defcolor cancelcolor rgb 0.0f 0.0f 0.0f
-\&.EQ }
-define cancel_cross 'special Cax'
-\&.EN
-\&.de Cax
-\&. ds 0s \\
-\\Z'\\\\*(0s'\\
-\\Z'\\D't 0.75p''\\
-\\m[cancelcolor]\\
-\\v'\\\\n(0du'\\
-\\D'l \\\\n(0wu -\\\\n(0hu-\\\\n(0du'\\
-\\h'-\\\\n(0wu'\\
-\\D'l \\\\n(0wu \\\\n(0hu+\\\\n(0du'\\
-\\v'-\\\\n(0hu-\\\\n(0du'\\
-\\Z'\\D't 0.5p''\\
-\\m[default]\\
-\\v'\\\\n(0hu'
-\&..
-.COE
-.CDE
-
-Then use it for example like this:
-.ICD "{ 4 times 1 } over { 4 times 5 } = { cancel_cross 4 times 1 } over { cancel_cross 4 times 5 }" .
-
-You can of course name your macro
-.ICD cancel
-instead of
-.ICD cancel_cross .
-The
-.ICD cancelcolor
-is also optional, and in the case above redundant.
-
-.HnS 1
-Simplify expressions in
-.I eqn
-.HnE
-
-When writing
-.I eqn
-expressions in
-.I groff
-it's easier to distinguish what is
-.I groff
-and what is
-.I eqn
-using distinct delimiters for
-.I eqn .
-This is simply
-accomplished this way:
-
-.CDS
-.COS
-\&.EQ
-delim ##
-\&.EN
-.COE
-.CDE
-
-Then use it like this:
-
-.CDS
-.COS
-[...]
-\&.LP
-Calculate the sum of #-4# and #-7#
-\&.sp 1
-\&.RS
-# (-4) + (-7) #
-
-# = -4 - 7 #
-
-# = -11
-\&.RE
-[...]
-.COE
-.CDE
diff --git a/noxz.tech/guides/groff/papers/.assemble b/noxz.tech/articles/sic_collection_of_papers_on_troff_and_its_companions/papers/.assemble
rename noxz.tech/guides/groff/papers/.assemble → noxz.tech/articles/sic_collection_of_papers_on_troff_and_its_companions/papers/.assemble
diff --git a/noxz.tech/articles/sic_collection_of_papers_on_troff_and_its_companions/papers/.buildignore b/noxz.tech/articles/sic_collection_of_papers_on_troff_and_its_companions/papers/.buildignore
diff --git a/noxz.tech/guides/groff/papers/a_guide_to_typesetting_mathematics_using_gnu_eqn.pdf b/noxz.tech/articles/sic_collection_of_papers_on_troff_and_its_companions/papers/a_guide_to_typesetting_mathematics_using_gnu_eqn.pdf
rename noxz.tech/guides/groff/papers/a_guide_to_typesetting_mathematics_using_gnu_eqn.pdf → noxz.tech/articles/sic_collection_of_papers_on_troff_and_its_companions/papers/a_guide_to_typesetting_mathematics_using_gnu_eqn.pdf
diff --git a/noxz.tech/guides/groff/papers/a_system_for_algorithm_animation__132.pdf b/noxz.tech/articles/sic_collection_of_papers_on_troff_and_its_companions/papers/a_system_for_algorithm_animation__132.pdf
rename noxz.tech/guides/groff/papers/a_system_for_algorithm_animation__132.pdf → noxz.tech/articles/sic_collection_of_papers_on_troff_and_its_companions/papers/a_system_for_algorithm_animation__132.pdf
diff --git a/noxz.tech/guides/groff/papers/a_system_for_typesetting_mathematics.pdf b/noxz.tech/articles/sic_collection_of_papers_on_troff_and_its_companions/papers/a_system_for_typesetting_mathematics.pdf
rename noxz.tech/guides/groff/papers/a_system_for_typesetting_mathematics.pdf → noxz.tech/articles/sic_collection_of_papers_on_troff_and_its_companions/papers/a_system_for_typesetting_mathematics.pdf
diff --git a/noxz.tech/guides/groff/papers/a_troff_tutorial.pdf b/noxz.tech/articles/sic_collection_of_papers_on_troff_and_its_companions/papers/a_troff_tutorial.pdf
rename noxz.tech/guides/groff/papers/a_troff_tutorial.pdf → noxz.tech/articles/sic_collection_of_papers_on_troff_and_its_companions/papers/a_troff_tutorial.pdf
diff --git a/noxz.tech/guides/groff/papers/a_typesetter-independent_troff.pdf b/noxz.tech/articles/sic_collection_of_papers_on_troff_and_its_companions/papers/a_typesetter-independent_troff.pdf
rename noxz.tech/guides/groff/papers/a_typesetter-independent_troff.pdf → noxz.tech/articles/sic_collection_of_papers_on_troff_and_its_companions/papers/a_typesetter-independent_troff.pdf
diff --git a/noxz.tech/guides/groff/papers/chem_--_a_language_for_typesetting_chemical_structure_diagram__122.pdf b/noxz.tech/articles/sic_collection_of_papers_on_troff_and_its_companions/papers/chem_--_a_language_for_typesetting_chemical_structure_diagram__122.pdf
rename noxz.tech/guides/groff/papers/chem_--_a_language_for_typesetting_chemical_structure_diagram__122.pdf → noxz.tech/articles/sic_collection_of_papers_on_troff_and_its_companions/papers/chem_--_a_language_for_typesetting_chemical_structure_diagram__122.pdf
diff --git a/noxz.tech/guides/groff/papers/dformat_--_a_program_for_typesetting_data_formats__142.pdf b/noxz.tech/articles/sic_collection_of_papers_on_troff_and_its_companions/papers/dformat_--_a_program_for_typesetting_data_formats__142.pdf
rename noxz.tech/guides/groff/papers/dformat_--_a_program_for_typesetting_data_formats__142.pdf → noxz.tech/articles/sic_collection_of_papers_on_troff_and_its_companions/papers/dformat_--_a_program_for_typesetting_data_formats__142.pdf
diff --git a/noxz.tech/guides/groff/papers/drawing-with-dpic.pdf b/noxz.tech/articles/sic_collection_of_papers_on_troff_and_its_companions/papers/drawing-with-dpic.pdf
rename noxz.tech/guides/groff/papers/drawing-with-dpic.pdf → noxz.tech/articles/sic_collection_of_papers_on_troff_and_its_companions/papers/drawing-with-dpic.pdf
diff --git a/noxz.tech/guides/groff/papers/grap_--_a_language_for_typesetting_graphs__114.pdf b/noxz.tech/articles/sic_collection_of_papers_on_troff_and_its_companions/papers/grap_--_a_language_for_typesetting_graphs__114.pdf
rename noxz.tech/guides/groff/papers/grap_--_a_language_for_typesetting_graphs__114.pdf → noxz.tech/articles/sic_collection_of_papers_on_troff_and_its_companions/papers/grap_--_a_language_for_typesetting_graphs__114.pdf
diff --git a/noxz.tech/guides/groff/papers/maintaining_cross_references_in_manuscripts__127.pdf b/noxz.tech/articles/sic_collection_of_papers_on_troff_and_its_companions/papers/maintaining_cross_references_in_manuscripts__127.pdf
rename noxz.tech/guides/groff/papers/maintaining_cross_references_in_manuscripts__127.pdf → noxz.tech/articles/sic_collection_of_papers_on_troff_and_its_companions/papers/maintaining_cross_references_in_manuscripts__127.pdf
diff --git a/noxz.tech/guides/groff/papers/making_pictures_with_gnu_pic.pdf b/noxz.tech/articles/sic_collection_of_papers_on_troff_and_its_companions/papers/making_pictures_with_gnu_pic.pdf
rename noxz.tech/guides/groff/papers/making_pictures_with_gnu_pic.pdf → noxz.tech/articles/sic_collection_of_papers_on_troff_and_its_companions/papers/making_pictures_with_gnu_pic.pdf
diff --git a/noxz.tech/guides/groff/papers/me_reference_manual.pdf b/noxz.tech/articles/sic_collection_of_papers_on_troff_and_its_companions/papers/me_reference_manual.pdf
rename noxz.tech/guides/groff/papers/me_reference_manual.pdf → noxz.tech/articles/sic_collection_of_papers_on_troff_and_its_companions/papers/me_reference_manual.pdf
diff --git a/noxz.tech/guides/groff/papers/nroff_troff_users_manual.pdf b/noxz.tech/articles/sic_collection_of_papers_on_troff_and_its_companions/papers/nroff_troff_users_manual.pdf
rename noxz.tech/guides/groff/papers/nroff_troff_users_manual.pdf → noxz.tech/articles/sic_collection_of_papers_on_troff_and_its_companions/papers/nroff_troff_users_manual.pdf
diff --git a/noxz.tech/guides/groff/papers/pic_--_a_graphics_language_for_typesetting__116.pdf b/noxz.tech/articles/sic_collection_of_papers_on_troff_and_its_companions/papers/pic_--_a_graphics_language_for_typesetting__116.pdf
rename noxz.tech/guides/groff/papers/pic_--_a_graphics_language_for_typesetting__116.pdf → noxz.tech/articles/sic_collection_of_papers_on_troff_and_its_companions/papers/pic_--_a_graphics_language_for_typesetting__116.pdf
diff --git a/noxz.tech/guides/groff/papers/some_applications_of_inverted_indexes_on_the_unix_system.pdf b/noxz.tech/articles/sic_collection_of_papers_on_troff_and_its_companions/papers/some_applications_of_inverted_indexes_on_the_unix_system.pdf
rename noxz.tech/guides/groff/papers/some_applications_of_inverted_indexes_on_the_unix_system.pdf → noxz.tech/articles/sic_collection_of_papers_on_troff_and_its_companions/papers/some_applications_of_inverted_indexes_on_the_unix_system.pdf
diff --git a/noxz.tech/guides/groff/papers/tbl_--_a_program_to_format_tables.pdf b/noxz.tech/articles/sic_collection_of_papers_on_troff_and_its_companions/papers/tbl_--_a_program_to_format_tables.pdf
rename noxz.tech/guides/groff/papers/tbl_--_a_program_to_format_tables.pdf → noxz.tech/articles/sic_collection_of_papers_on_troff_and_its_companions/papers/tbl_--_a_program_to_format_tables.pdf
diff --git a/noxz.tech/guides/groff/papers/tbl_--_a_program_to_format_tables__76.pdf b/noxz.tech/articles/sic_collection_of_papers_on_troff_and_its_companions/papers/tbl_--_a_program_to_format_tables__76.pdf
rename noxz.tech/guides/groff/papers/tbl_--_a_program_to_format_tables__76.pdf → noxz.tech/articles/sic_collection_of_papers_on_troff_and_its_companions/papers/tbl_--_a_program_to_format_tables__76.pdf
diff --git a/noxz.tech/guides/groff/papers/tools_for_printing_indexes__128.pdf b/noxz.tech/articles/sic_collection_of_papers_on_troff_and_its_companions/papers/tools_for_printing_indexes__128.pdf
rename noxz.tech/guides/groff/papers/tools_for_printing_indexes__128.pdf → noxz.tech/articles/sic_collection_of_papers_on_troff_and_its_companions/papers/tools_for_printing_indexes__128.pdf
diff --git a/noxz.tech/guides/groff/papers/typesetting_mathematics_users_guide__second_edition.pdf b/noxz.tech/articles/sic_collection_of_papers_on_troff_and_its_companions/papers/typesetting_mathematics_users_guide__second_edition.pdf
rename noxz.tech/guides/groff/papers/typesetting_mathematics_users_guide__second_edition.pdf → noxz.tech/articles/sic_collection_of_papers_on_troff_and_its_companions/papers/typesetting_mathematics_users_guide__second_edition.pdf
diff --git a/noxz.tech/guides/groff/papers/using_the_ms_macros_with_troff_and_nroff.pdf b/noxz.tech/articles/sic_collection_of_papers_on_troff_and_its_companions/papers/using_the_ms_macros_with_troff_and_nroff.pdf
rename noxz.tech/guides/groff/papers/using_the_ms_macros_with_troff_and_nroff.pdf → noxz.tech/articles/sic_collection_of_papers_on_troff_and_its_companions/papers/using_the_ms_macros_with_troff_and_nroff.pdf
diff --git a/noxz.tech/guides/groff/papers/writing_papers_with_nroff_using_me.pdf b/noxz.tech/articles/sic_collection_of_papers_on_troff_and_its_companions/papers/writing_papers_with_nroff_using_me.pdf
rename noxz.tech/guides/groff/papers/writing_papers_with_nroff_using_me.pdf → noxz.tech/articles/sic_collection_of_papers_on_troff_and_its_companions/papers/writing_papers_with_nroff_using_me.pdf
diff --git a/noxz.tech/guides/groff/simple_compiler_for_vim/.assemble b/noxz.tech/articles/simple_groff_compiler_for_vim/.assemble
rename noxz.tech/guides/groff/simple_compiler_for_vim/.assemble → noxz.tech/articles/simple_groff_compiler_for_vim/.assemble
diff --git a/noxz.tech/articles/simple_groff_compiler_for_vim/.buildignore b/noxz.tech/articles/simple_groff_compiler_for_vim/.buildignore
diff --git a/noxz.tech/articles/simple_groff_compiler_for_vim/.metadata b/noxz.tech/articles/simple_groff_compiler_for_vim/.metadata
@@ -0,0 +1,5 @@
+.ds YEAR 2019
+.ds MONTH October
+.ds DAY 26
+.ds DATE \*[MONTH] \*[DAY], \*[YEAR]
+.ds TITLE Simple groff compiler for vim
diff --git a/noxz.tech/guides/groff/simple_compiler_for_vim/index.www b/noxz.tech/articles/simple_groff_compiler_for_vim/index.www
rename noxz.tech/guides/groff/simple_compiler_for_vim/index.www → noxz.tech/articles/simple_groff_compiler_for_vim/index.www
@@ -1,13 +1,15 @@
-When writing documents in vim it's nice to have a quick way of compiling them
-into desired formats. In my case I compile my groff files into pdfs, while at
-the same time having a preview in zathura. Zathura automatically detects
+When writing documents in vim, it's nice to have a quick way of compiling them
+into the desired formats. In my case, I compile my groff files into pdfs while
+at the same time having a preview in
+.ICD zathura .
+Zathura automatically detects
changes in pdfs and reloads accordingly, which is nice.
.HnS 1
The compiler code
.HnE
-Below I will describe the code in short.
+Below, I will describe the code in short.
.CDS
.COS
@@ -44,11 +46,11 @@ esac
The script above is called
.I compile
and is intended to be used for multiple
-file types. In this version I have only implemented support for
+file types. In this version, I have only implemented support for
.I .ms
files.
-First the filename is read from the first argument to the script. From the
-filename I determine the directory path and the "base name" without the
+First, the filename is read from the first argument to the script. From the
+filename, I determine the directory path and the "base name" without the
filename's extension. In the file I search for the pattern
.I ---COMPILE:
as it
@@ -56,10 +58,10 @@ may contain additional arguments for the compiler (used above as
.I $_ARGS ).
The script then changes the directory to the file's directory and executes a
-chain of programs. First
+chain of programs. First,
.I preconv
is executed to handle unicode characters.
-Then
+Then,
.I refer
handles references,
.I eqn
@@ -69,7 +71,7 @@ handles pictures, groff compiles everything into an
.I a4
pdf using the
.I ms
-macro set and finally Ghostscript runs post processing and embeds used fonts
+macro set, and finally, Ghostscript runs post processing and embeds used fonts
into the pdf (while preserving hyperlinks).
Everything is then being outputted to the same "base name", but as a pdf file.
@@ -78,7 +80,7 @@ Everything is then being outputted to the same "base name", but as a pdf file.
Usage in vim
.HnE
-In vim I have the following key binding set to compile the document upon
+In vim, I have the following key binding set to compile the document upon
request.
.CDS
@@ -87,8 +89,8 @@ map <leader>c :w! \| silent !compile <c-r>%<CR><Esc>:redraw!<CR>
.COE
.CDE
-Not much to say here. The document is being saved, compiled and then vim is
-being redrawn (to avoid glitches).
+There isn't much to say about this. The document is being saved, compiled, and
+then vim is being redrawn (to avoid glitches).
.HnS 1
Workflow
@@ -96,7 +98,7 @@ Workflow
My usual workflow for writing documents in vim, using the above compiler,
consists of me first starting a terminal (with tmux). I then open a new tab,
-start vim and setup everything for a base document in groff. After that I run
-the compiler to create an empty pdf. In the first tab I execute zathura to view
-the pdf. As I use dwm (a tiling window manager), I have vim on one side of the
-screen and zathura on the other. Simple and functional!
+start vim, and setup everything for a base document in groff. After that, I run
+the compiler to create an empty pdf. In the first tab, I execute zathura to
+view the pdf. As I use dwm (a tiling window manager), I have vim on one side of
+the screen and zathura on the other. Simple and functional!
diff --git a/noxz.tech/guides/groff/writing_a_resume_in_groff/.assemble b/noxz.tech/articles/writing_a_resume_in_groff/.assemble
rename noxz.tech/guides/groff/writing_a_resume_in_groff/.assemble → noxz.tech/articles/writing_a_resume_in_groff/.assemble
diff --git a/noxz.tech/articles/writing_a_resume_in_groff/.buildignore b/noxz.tech/articles/writing_a_resume_in_groff/.buildignore
diff --git a/noxz.tech/articles/writing_a_resume_in_groff/.metadata b/noxz.tech/articles/writing_a_resume_in_groff/.metadata
@@ -0,0 +1,5 @@
+.ds YEAR 2019
+.ds MONTH October
+.ds DAY 23
+.ds DATE \*[MONTH] \*[DAY], \*[YEAR]
+.ds TITLE Writing a resume in groff
diff --git a/noxz.tech/guides/groff/writing_a_resume_in_groff/example.png b/noxz.tech/articles/writing_a_resume_in_groff/example.png
rename noxz.tech/guides/groff/writing_a_resume_in_groff/example.png → noxz.tech/articles/writing_a_resume_in_groff/example.png
diff --git a/noxz.tech/guides/groff/writing_a_resume_in_groff/index.www b/noxz.tech/articles/writing_a_resume_in_groff/index.www
rename noxz.tech/guides/groff/writing_a_resume_in_groff/index.www → noxz.tech/articles/writing_a_resume_in_groff/index.www
@@ -1,6 +1,6 @@
-Writing a curriculum in groff can seem difficult, but rest assured it can
-easily be accomplished and in this guide I will show how a simple resume can be
-created. In this guide I will use the macro set
+Writing a resume in groff can seem difficult, but rest assured it can easily be
+accomplished, and in this guide I will show how a simple resume can be created.
+In this guide I will use the macro set
.I ms ,
so remember to compile the document using
.I \[u2011]ms .
@@ -15,7 +15,7 @@ program to create tables, so remember to first compile the document in
Settings
.HnE
-To begin with let's add some settings in the head of the document.
+To begin with, let's add some settings in the head of the document.
.CDS
.COS
@@ -26,9 +26,9 @@ To begin with let's add some settings in the head of the document.
.COE
.CDE
-In the section above we have specified the font family
+In the section above, we have specified the font family
.ICD T
-(times), a point size of
+(Times), a point size of
.ICD 10p ,
a line spacing of
.ICD 15p
@@ -39,7 +39,7 @@ blank).
Coloring
.HnE
-Next let's define some of the coloring that we are going to use later.
+Next, let's define some of the colors that we are going to use later.
.CDS
.COS
@@ -58,7 +58,7 @@ will be used for a vertical line in each section (more on that later).
Macros
.HnE
-To avoid a lot of typing for each heading we will create a macro instead.
+To avoid a lot of typing for each heading, we will create a macro instead.
.CDS
.COS
@@ -79,19 +79,19 @@ To avoid a lot of typing for each heading we will create a macro instead.
In the macro
.ICD heading
-above we start by telling groff not to fill output lines. We set the point size
-to
+above, we start by telling groff not to fill output lines. We set the point
+size to
.ICD 14 ,
-print the input parameter in bold and the continue by drawing. When drawing we
-first move horizontally to the position
+print the input parameters in bold, and then continue by drawing. When drawing,
+we first move horizontally to the position
.ICD 0n ,
-move vertically up
+then move vertically up
.ICD 1.2n
and change the pen color to the previously defined
.ICD headingcolor .
-After that we just draw an underline
+After that, we just draw an underline
.ICD \[u005C](ul
-from where we are to the most right of the documents writing area. Finally we
+from where we are to the most right of the document's writing area. Finally, we
change the color back to
.ICD default ,
revert the point size back to
@@ -127,29 +127,30 @@ T}
.COE
.CDE
-In the example above we tell groff to center the following two lines where we
+In the example above, we tell groff to center the following two lines where we
print the name
.ICD "John F. Smith"
-(with the point size of
-.ICD 18 ),
-and his email address (with the point size of
+(with a point size of
+.ICD 18 )
+and his email address (with a point size of
.ICD 10 ).
Then we create a table using
.ICD .TS
-(table start) ending with
+(table start) and ending with
.ICD .TE
-(table ending). We define the tab separation, that will separate each cell, as
+(table ending). We specify the tab separation that will be used to separate
+each cell as
.ICD ;
-and tell
+and instruct
.ICD tbl
to ignore spaces. The format of the table is
.ICD "l rx."
which means that the first cell is left aligned, the second cell is right
-aligned and extended (to fill the writing area) and the dot tells
+aligned and extended (to fill the writing area), and the dot tells
.ICD tbl
to end the format there.
-The content are then specified with each row on one line (with some caveats)
+The contents are then specified with each row on one line (with some caveats)
and cells separated using
.ICD ; .
As we tell groff to use italics
@@ -160,9 +161,8 @@ to treat the content as text blocks using
.ICD T{
and
.ICD T} .
-The symbol
.ICD T{
-must be after the
+must come after the
.ICD ;
and
.ICD T}
@@ -172,8 +172,8 @@ must be on its own line.
A short summary
.HnE
-We will of course need a short summary in our resume. You can of course write
-what ever you want here, and not necessarily
+We will, of course, need a short summary in our resume. You can, of course,
+write whatever you want here, and not necessarily
.I "lorem ipsum dolor sit amet..."
.CDS
@@ -190,7 +190,7 @@ est laborum.
.COE
.CDE
-In the example above we have taken advantage of our macro named
+In the example above, we have taken advantage of our macro named
.ICD heading
to format the heading
.ICD Summary .
@@ -204,9 +204,9 @@ used since the 1500s.
Sections
.HnE
-At last we create some sections for our various topics in the resume. These can
-of course vary depending on the person or position in mind. I will just create
-some examples.
+Finally, we create some sections for our various topics in the resume. These
+can, of course, vary depending on the person or position in mind. I will just
+create some examples.
.CDS
.COS
@@ -236,14 +236,14 @@ T}
.COE
.CDE
-In the example above we are once again using the macro
+In the example above, we are once again using the macro
.ICD heading
to create a new heading for our experiences. The content is rendered inside a
-table, but this time the table formatting is a bit different. In this case
+table, but this time the table formatting is a bit different. In this case,
.ICD rW15|lx.
means that the first cell is right aligned with a fixed width of
.ICD 15
-(you might have to change this to work for your resume). The two cells will be
+(you might have to change this to work for your resume). The two cells will be
divided by a line, specified using the
.ICD | ,
and the second cell will be left aligned and extended (to fill the writing
@@ -252,28 +252,28 @@ area).
Here we use the previously defined color
.ICD linecolor
for printing the separation line. First we make sure the default color is
-selected, define the first cell (here containing a date) and the set the new
-color
+selected, then we define the first cell (here containing a date) and then set
+the new color
.ICD linecolor .
-For our content we once again use a text block to enable us to use formatting
+For our content, we once again use a text block to enable us to use formatting
and longer texts.
-In our text block we first define the position, employer and location separated
-with an
+In our text block, we first define the position, employer, and location,
+separated with an
.I "en"
dash. We break the line using
.ICD .br
-and add some descriptive text for the position. Finally we add some vertical
-spacing with the value
+and add some descriptive text for the position. Finally, we add some vertical
+spacing with a value of
.ICD 0.5 .
-After the table is ended we make sure the default color is set.
+After the table is ended, we make sure the default color is set.
.HnS 1
Conclusion
.HnE
-Together with all information above we can now create a final document to
+Together with all the information above, we can now create a final document to
compile into our resume. I've created a template
.URL template.ms here
-based on this guide. Feel free to use it and change it in what ever way you
+based on this guide. Feel free to use it and change it in whatever way you
want.
diff --git a/noxz.tech/guides/groff/writing_a_resume_in_groff/template.ms b/noxz.tech/articles/writing_a_resume_in_groff/template.ms
rename noxz.tech/guides/groff/writing_a_resume_in_groff/template.ms → noxz.tech/articles/writing_a_resume_in_groff/template.ms
diff --git a/noxz.tech/guides/.metadata b/noxz.tech/guides/.metadata
@@ -1 +0,0 @@
-.ds TITLE Guides
diff --git a/noxz.tech/guides/groff/.metadata b/noxz.tech/guides/groff/.metadata
@@ -1 +0,0 @@
-.ds TITLE groff (GNU troff)
diff --git a/noxz.tech/guides/groff/simple_compiler_for_vim/.metadata b/noxz.tech/guides/groff/simple_compiler_for_vim/.metadata
@@ -1 +0,0 @@
-.ds TITLE Simple compiler for vim
diff --git a/noxz.tech/guides/groff/writing_a_resume_in_groff/.metadata b/noxz.tech/guides/groff/writing_a_resume_in_groff/.metadata
@@ -1 +0,0 @@
-.ds TITLE Writing a resume in groff
diff --git a/noxz.tech/guides/index.www b/noxz.tech/guides/index.www
@@ -1,16 +0,0 @@
-The following is a collection of guides, hacks, HOWTOs, tips and tricks \(en I
-have acquired over the years \(en for various programs and concepts. I will
-fill this list over a period of time, so it's far from complete \(en and
-probably never will be.
-
-.HnS 1
-Programs
-.HnE
-
-.DLS
-.LIURL groff "Groff"
-(also called GNU troff) is a typesetting system
-that creates formatted output when given plain text mixed with formatting
-commands. Output may be PostScript or PDF, html, or ASCII/UTF8 for display at
-the terminal.
-.DLE
