threads / patch / 35606

patchImprove user-manual html and pdf formatting

Subject: [PATCH] Improve user-manual html and pdf formatting

## tl;dr

7 messages between Jan 4, 2014 and Jan 6, 2014. Diffs are folded; open one to read it.

replies: 6people: 5as markdown or json

Thomas Ackermann· Jan 4, 2014, 09:07 UTC · lore

Use asciidoc style 'article' instead of 'book' and change asciidoc title level. This removes blank first page and superfluous "Part I" page (there is no "Part II") in pdf output. Also pdf size is decreased by this from 77 to 67 pages. In html output this removes unnecessary sub-tocs and chapter numbering.

Signed-off-by: Thomas Ackermann <th.acker@arcor.de>
---
 Documentation/Makefile        | 2 +-
 Documentation/user-manual.txt | 4 ++--
 2 files changed, 3 insertions(+), 3 deletions(-)

Show changes to 2 files +3 −3

Documentation/Makefile, Documentation/user-manual.txt

diff --git a/Documentation/Makefile b/Documentation/Makefile
index 91a12c7..36c58fc 100644
--- a/Documentation/Makefile
+++ b/Documentation/Makefile
@@ -324,7 +324,7 @@ manpage-base-url.xsl: manpage-base-url.xsl.in
 
 user-manual.xml: user-manual.txt user-manual.conf
 	$(QUIET_ASCIIDOC)$(RM) $@+ $@ && \
-	$(ASCIIDOC) $(ASCIIDOC_EXTRA) -b docbook -d book -o $@+ $< && \
+	$(ASCIIDOC) $(ASCIIDOC_EXTRA) -b docbook -d article -o $@+ $< && \
 	mv $@+ $@
 
 technical/api-index.txt: technical/api-index-skel.txt \
diff --git a/Documentation/user-manual.txt b/Documentation/user-manual.txt
index cbb01a1..130c2f4 100644
--- a/Documentation/user-manual.txt
+++ b/Documentation/user-manual.txt
@@ -1,5 +1,5 @@
-Git User Manual
-_______________
+&#65279;Git User Manual
+===============
 
 Git is a fast distributed revision control system.

-- 
1.8.5.2.msysgit.0


---
Thomas

Jonathan Nieder· Jan 4, 2014, 21:18 UTC · re: Thomas Ackermann · lore

Re: [PATCH] Improve user-manual html and pdf formatting

Hi,

Thomas Ackermann wrote:

Show 5 quoted lines

> --- a/Documentation/user-manual.txt
> +++ b/Documentation/user-manual.txt
> @@ -1,5 +1,5 @@
> -Git User Manual
> +&#65279;Git User Manual

Why?

Puzzled, Jonathan

Øystein Walle· Jan 4, 2014, 21:38 UTC · re: Jonathan Nieder · lore

Re: [PATCH] Improve user-manual html and pdf formatting

Jonathan Nieder <jrnieder <at> gmail.com> writes:

Show 16 quoted lines

> 
> Hi,
> 
> Thomas Ackermann wrote:
> 
> > --- a/Documentation/user-manual.txt
> > +++ b/Documentation/user-manual.txt
> >  <at>  <at>  -1,5 +1,5  <at>  <at> 
> > -Git User Manual
> > +&#65279;Git User Manual
> 
> Why?
> 
> Puzzled,
> Jonathan
>

That's a Unicode Byte Order Mark. In UTF-8 it serves no purpose except to indicate that a file is in fact UTF-8. A job which most editors don't need help with.

See http://en.wikipedia.org/wiki/Byte_order_mark

Øsse

Andreas Schwab· Jan 4, 2014, 21:54 UTC · re: Øystein Walle · lore

Re: [PATCH] Improve user-manual html and pdf formatting

Øystein Walle <oystwa@gmail.com> writes:

Show 20 quoted lines

> Jonathan Nieder <jrnieder <at> gmail.com> writes:
>
>> 
>> Hi,
>> 
>> Thomas Ackermann wrote:
>> 
>> > --- a/Documentation/user-manual.txt
>> > +++ b/Documentation/user-manual.txt
>> >  <at>  <at>  -1,5 +1,5  <at>  <at> 
>> > -Git User Manual
>> > +&#65279;Git User Manual
>> 
>> Why?
>> 
>> Puzzled,
>> Jonathan
>> 
>
> That's a Unicode Byte Order Mark.

No, its an ampersand, a hash, a number and a semicolon. Definitely not a BOM.

Andreas.

-- 
Andreas Schwab, schwab@linux-m68k.org
GPG Key fingerprint = 58CA 54C7 6D53 942B 1756  01D3 44D5 214B 8276 4ED5
"And now for something completely different."

Øystein Walle· Jan 4, 2014, 22:12 UTC · re: Andreas Schwab · lore

Re: [PATCH] Improve user-manual html and pdf formatting

Andreas Schwab <schwab <at> linux-m68k.org> writes:

Show 7 quoted lines

> > That's a Unicode Byte Order Mark.
> 
> No, its an ampersand, a hash, a number and a semicolon.  Definitely not
> a BOM.
> 
> Andreas.
>

You're right, of course :) I was a bit hasty.

#65279; is a HTML entity (or at least something like looks like one) for the character U+FEFF, which also serves as the Byte Order Mark. I assume the entity was added to the file by mistake.

Øsse

Thomas Ackermann· Jan 5, 2014, 08:22 UTC · re: Jonathan Nieder · lore

Aw: Re: [PATCH] Improve user-manual html and pdf formatting

 
This originally was an UTF8-BOM in user-manual.txt and notepad++ was so clever
not to show it in the patch-file :-| Pasting this into my webmail then produced 
complete rubbish which I didn't noticed ...

----- Original Nachricht ----
Von:     Jonathan Nieder <jrnieder@gmail.com>
An:      Thomas Ackermann <th.acker@arcor.de>
Datum:   04.01.2014 22:18
Betreff: Re: [PATCH] Improve user-manual html and pdf formatting

Show 15 quoted lines

> Hi,
> 
> Thomas Ackermann wrote:
> 
> > --- a/Documentation/user-manual.txt
> > +++ b/Documentation/user-manual.txt
> > @@ -1,5 +1,5 @@
> > -Git User Manual
> > +&#65279;Git User Manual
> 
> Why?
> 
> Puzzled,
> Jonathan
>

--- Thomas

Junio C Hamano· Jan 6, 2014, 17:20 UTC · re: Thomas Ackermann · lore

Re: [PATCH] Improve user-manual html and pdf formatting

Thomas Ackermann <th.acker@arcor.de> writes:

Show 33 quoted lines

> Use asciidoc style 'article' instead of 'book' and change asciidoc title level.
> This removes blank first page and superfluous "Part I" page (there is no "Part II")
> in pdf output. Also pdf size is decreased by this from 77 to 67 pages.
> In html output this removes unnecessary sub-tocs and chapter numbering.
>
> Signed-off-by: Thomas Ackermann <th.acker@arcor.de>
> ---
>  Documentation/Makefile        | 2 +-
>  Documentation/user-manual.txt | 4 ++--
>  2 files changed, 3 insertions(+), 3 deletions(-)
>
> diff --git a/Documentation/Makefile b/Documentation/Makefile
> index 91a12c7..36c58fc 100644
> --- a/Documentation/Makefile
> +++ b/Documentation/Makefile
> @@ -324,7 +324,7 @@ manpage-base-url.xsl: manpage-base-url.xsl.in
>  
>  user-manual.xml: user-manual.txt user-manual.conf
>  	$(QUIET_ASCIIDOC)$(RM) $@+ $@ && \
> -	$(ASCIIDOC) $(ASCIIDOC_EXTRA) -b docbook -d book -o $@+ $< && \
> +	$(ASCIIDOC) $(ASCIIDOC_EXTRA) -b docbook -d article -o $@+ $< && \
>  	mv $@+ $@
>  
>  technical/api-index.txt: technical/api-index-skel.txt \
> diff --git a/Documentation/user-manual.txt b/Documentation/user-manual.txt
> index cbb01a1..130c2f4 100644
> --- a/Documentation/user-manual.txt
> +++ b/Documentation/user-manual.txt
> @@ -1,5 +1,5 @@
> -Git User Manual
> -_______________
> +&#65279;Git User Manual
> +===============

Will queue after dropping the extra.

Thanks.