Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[roff/en] New language added - roff #5194

Open
wants to merge 2 commits into
base: master
Choose a base branch
from
Open

Conversation

jecxjo
Copy link
Contributor

@jecxjo jecxjo commented Nov 26, 2024

  • I solemnly swear that this is all original content of which I am the original author
  • Pull request title is prepended with [language/lang-code] (example [python/fr-fr] or [java/en])
  • Pull request touches only one file (or a set of logically related files with similar changes made)
  • Content changes are aimed at intermediate to experienced programmers (this is a poor format for explaining fundamental programming concepts)
  • If you've changed any part of the YAML Frontmatter, make sure it is formatted according to CONTRIBUTING.md
    • Yes, I have double-checked quotes and field names!

roff.html.markdown Outdated Show resolved Hide resolved
@nbehrnd
Copy link
Contributor

nbehrnd commented Nov 26, 2024

@jecxjo This is great idea by you. Do you plan to extend this (either here with an additional note, a separate file) about Peter Schaffter's mom? Note, line 72 includes a trailing space.

In line with for instance the AWK file, I would however propose to change the beginning: setup of the file and preliminaries in markdown, the "paper" as such in roff, and the references to additional resources again in markdown. What do you two think about this? Open for discussion, the first 40 lines could look like in the file attached below.

Regarding the contents

  • The document shows how to compile the pdf successfully altogether with groff's prepocessors required here. However, though introduced as such, the bridge between -eqn (long) -> -e (short form), -pic -> -p, etc is not clearly established.
  • The document hints to additional information for an installation of groff in Linux. In my case (Linux Debian 13/trixie), the suggested command man 1 groff_me will not lead to the man page in question; instead, it is man groff_me. In addition, Debian puts provides this man page in section 7 (miscellaneous) and not in section 1 (general commands). The same pattern is observed for groff_ms. Could the organization depend on the Linux distribution in charge/differ in the one you access?
  • Though it is not a preprocessor (like pic) and the document is in the English section of the project, I recommend to add a note about the optional parameter/flag -Kutf8 to ease input and processing strings with diacritics like école, français, español, etc.

start.txt

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants