Bug 202303

Summary: [patch] Better configuration for Emacs
Product: Documentation Reporter: Hoyoung Kim <trig4800>
Component: Books & ArticlesAssignee: Warren Block <wblock>
Status: Closed FIXED    
Severity: Affects Some People CC: wblock
Priority: --- Keywords: patch
Version: Latest   
Hardware: Any   
OS: Any   
Attachments:
Description Flags
Change in en_US.ISO8859-1/books/fdp-primer/editor-config/chapter.xml none

Description Hoyoung Kim 2015-08-13 18:14:40 UTC 
Created attachment 159839 [details]
Change in en_US.ISO8859-1/books/fdp-primer/editor-config/chapter.xml

FDP requires following guidelines:

- Word wrap set to 70 characters.
- Tab stops set to 2.
- Replace each group of 8 leading spaces with a single tab.

Configuration for Emacs is suggested in FDP Primer:

https://www.freebsd.org/doc/en_US.ISO8859-1/books/fdp-primer/editor-config-emacs.html

However, this method(psgml-mode) is not a good one, because:

1. It doesn't work properly.
2. It's too old.
3. It is not the built-in feature of Emacs.

When editing xml files with *modern* Emacs, nxml-mode is usually recommended.
It is also default setting for Emacs.

nxml-mode combined with auto-fill-mode can do the job.

Specifically, adding this line to ~/.emacs:

(add-hook 'nxml-mode-hook 'turn-on-auto-fill)

I'm translating some articles with this configuration, and it seems to be working well.

P.S. These are my questions related to this topic:

https://lists.freebsd.org/pipermail/freebsd-doc/2015-June/025339.html
http://stackoverflow.com/questions/31359658/emacs-configuration-for-xml-files-of-freebsd-documentation-project
https://forums.freebsd.org/threads/emacs-configuration-for-freebsd-documentation-project.51857/#post-294083

And this is a manual for nxml-mode from GNU Project.

https://www.gnu.org/software/emacs/manual/html_node/nxml-mode/index.html
Comment 1 Warren Block freebsd_committer freebsd_triage 2015-08-14 02:07:49 UTC 
The patch removes the wordwrap and indent settings.  Does nxml-mode have these set by default?
Comment 2 Hoyoung Kim 2015-08-14 06:09:09 UTC 
(In reply to Warren Block from comment #1)

Yes.  nxml-mode provides 'tab stops set to 2' and 'replace each group of 8 leading spaces with a single tab'.  auto-fill-mode provides 'word wrap set to 70 characters'.

It would be appreciated if someone experts in FDP tests for this configuration.

This is not a *perfect* solution because of the indentation issue(https://docs.freebsd.org/cgi/getmsg.cgi?fetch=119948+0+archive/2015/freebsd-doc/20150719.freebsd-doc), but this one would be more helpful than the previous one.
Comment 3 Warren Block freebsd_committer freebsd_triage 2015-08-14 23:07:57 UTC 
Committed, thanks!
Comment 4 commit-hook freebsd_committer freebsd_triage 2015-08-14 23:08:27 UTC 
A commit references this bug:

Author: wblock
Date: Fri Aug 14 23:07:33 UTC 2015
New revision: 47235
URL: https://svnweb.freebsd.org/changeset/doc/47235

Log:
  Update the emacs configuration.

  PR:		202303
  Submitted by:	Hoyoung Kim <trig4800@gmail.com>

Changes:
  head/en_US.ISO8859-1/books/fdp-primer/editor-config/chapter.xml