Re: FDP Primer: emacs and vim

2013-07-23 Thread Marc Fonvieille
On Mon, Jul 22, 2013 at 09:11:43PM +0200, Remko Lodder wrote:
> 
> On Jul 22, 2013, at 5:54 AM, Glen Barber  wrote:
> 
> > On Sun, Jul 21, 2013 at 09:37:05PM -0600, Warren Block wrote:
> >>vim users, provide an updated configuration for vim.
> > 
> > http://people.freebsd.org/~gjb/vimrc.txt
> > 
> > Hopefully useful to others.
> > 
> > Glen
> 
> thanks!!
>

http://svnweb.freebsd.org/doc/head/share/examples/vim/

for style(9): http://svnweb.freebsd.org/base/head/tools/tools/editing/


pgpp0h7Beql8X.pgp
Description: PGP signature


CFR: documentation rendered in PDF with FOP

2013-07-23 Thread Gabor Kovesdan

Hi,

I'm working on new rendering solutions for our documentation. One 
renderer will be dblatex, which doesn't depend on Java but doesn't give 
such high quality output. The other one will be FOP, which is written is 
Java but produces better quality.


Here are some PDFs for review, rendered with Apache FOP:
http://kovesdan.org/files/fop/

I need suggestions for royalty-free print-quality Bengali, Greek and 
Cyrillic fonts since these are still not customized and the default 
fonts lack non-Latin glyphs.


Apart from this, any comments are welcome. I know some parts still need 
improvements but feel free to comment on anything you think that should 
be changed.


Gabor
___
freebsd-doc@freebsd.org mailing list
http://lists.freebsd.org/mailman/listinfo/freebsd-doc
To unsubscribe, send any mail to "freebsd-doc-unsubscr...@freebsd.org"


Re: CFR: documentation rendered in PDF with FOP

2013-07-23 Thread Daniel Seuffert
Am 23.07.2013 15:38, schrieb Gabor Kovesdan:
> Hi,
> 
> I'm working on new rendering solutions for our documentation. One
> renderer will be dblatex, which doesn't depend on Java but doesn't
> give such high quality output. The other one will be FOP, which is
> written is Java but produces better quality.
> 
> Here are some PDFs for review, rendered with Apache FOP:
> http://kovesdan.org/files/fop/
> 
> I need suggestions for royalty-free print-quality Bengali, Greek and
> Cyrillic fonts since these are still not customized and the default
> fonts lack non-Latin glyphs.
> 
> Apart from this, any comments are welcome. I know some parts still
> need improvements but feel free to comment on anything you think
> that should be changed.


Hi Gabor,

thank you and the others so much for your work! :-)

Fonts: Please have a close look at Gentium please, that's used on
our flyers for a lot of reasons:

http://scripts.sil.org/cms/scripts/page.php?site_id=nrsi&id=gentium

Bengali I'm sorry, I have absolutely no clue.

Best regards, Daniel


___
freebsd-doc@freebsd.org mailing list
http://lists.freebsd.org/mailman/listinfo/freebsd-doc
To unsubscribe, send any mail to "freebsd-doc-unsubscr...@freebsd.org"


docs/180767: [man][libc] printf.3: fix off-by-one in snprintf description

2013-07-23 Thread Dmitry Marakasov

>Number: 180767
>Category:   docs
>Synopsis:   [man][libc] printf.3: fix off-by-one in snprintf description
>Confidential:   no
>Severity:   non-critical
>Priority:   low
>Responsible:freebsd-doc
>State:  open
>Quarter:
>Keywords:   
>Date-Required:
>Class:  doc-bug
>Submitter-Id:   current-users
>Arrival-Date:   Tue Jul 23 15:10:00 UTC 2013
>Closed-Date:
>Last-Modified:
>Originator: Dmitry Marakasov
>Release:FreeBSD 9.1-RELEASE-p4 amd64
>Organization:
>Environment:
System: FreeBSD hades.panopticon 9.1-RELEASE-p4 FreeBSD 9.1-RELEASE-p4 #0 
r251956: Tue Jun 18 21:41:37 MSK 2013 
root@hades.panopticon:/usr/obj/usr/src/sys/HADES amd64


>Description:
printf(3) says for snprintf:

 The snprintf() and vsnprintf() functions will write at most size-1 of the
 characters printed into the output string (the size'th character then
 gets the terminating `\0');

the part in parenteses is incorrect: size'th character is outside
buffer of [size] characters. It should instead say "(size-1)'th
character" (which is last in the buffer).

>How-To-Repeat:
>Fix:

--- printf.3.patch begins here ---
Index: lib/libc/stdio/printf.3
===
--- lib/libc/stdio/printf.3 (revision 253572)
+++ lib/libc/stdio/printf.3 (working copy)
@@ -143,7 +143,7 @@
 .Fa size Ns \-1
 of the characters printed into the output string
 (the
-.Fa size Ns 'th
+.Fa ( size Ns \-1)'th
 character then gets the terminating
 .Ql \e0 ) ;
 if the return value is greater than or equal to the
--- printf.3.patch ends here ---

>Release-Note:
>Audit-Trail:
>Unformatted:
___
freebsd-doc@freebsd.org mailing list
http://lists.freebsd.org/mailman/listinfo/freebsd-doc
To unsubscribe, send any mail to "freebsd-doc-unsubscr...@freebsd.org"


Re: CFR: documentation rendered in PDF with FOP

2013-07-23 Thread Gabor Kovesdan

On 2013.07.23. 15:46, Daniel Seuffert wrote:

Fonts: Please have a close look at Gentium please, that's used on
our flyers for a lot of reasons:

http://scripts.sil.org/cms/scripts/page.php?site_id=nrsi&id=gentium
Thanks Daniel, it indeed seems nice! I've partly regenerated the 
documents, I'm still experimenting with font settings but now we are one 
step closer to the goal.


Gabor
___
freebsd-doc@freebsd.org mailing list
http://lists.freebsd.org/mailman/listinfo/freebsd-doc
To unsubscribe, send any mail to "freebsd-doc-unsubscr...@freebsd.org"


Re: docs/18590: commit references a PR

2013-07-23 Thread dfilter service
The following reply was made to PR docs/18590; it has been noted by GNATS.

From: dfil...@freebsd.org (dfilter service)
To: bug-follo...@freebsd.org
Cc:  
Subject: Re: docs/18590: commit references a PR
Date: Tue, 23 Jul 2013 20:35:20 + (UTC)

 Author: pawel
 Date: Tue Jul 23 20:35:11 2013
 New Revision: 323548
 URL: http://svnweb.freebsd.org/changeset/ports/323548
 
 Log:
   Cyrus2Dovecot is a full-featured command line tool for converting the
   e-mails of one or more users from Cyrus format to Dovecot Maildir++ folders.
   It allows for performing a server transition which is fully transparent to
   both POP and IMAP users.
   
   WWW: http://www.cyrus2dovecot.sw.fu-berlin.de/
   
   PR:  ports/18590
   Submitted by:Vladimir Kondratiev 
 
 Added:
   head/mail/cyrus2dovecot/
   head/mail/cyrus2dovecot/Makefile   (contents, props changed)
   head/mail/cyrus2dovecot/distinfo   (contents, props changed)
   head/mail/cyrus2dovecot/pkg-descr   (contents, props changed)
 Modified:
   head/mail/Makefile
 
 Modified: head/mail/Makefile
 ==
 --- head/mail/Makefile Tue Jul 23 20:00:53 2013(r323547)
 +++ head/mail/Makefile Tue Jul 23 20:35:11 2013(r323548)
 @@ -85,6 +85,7 @@
  SUBDIR += cyrus-imapd23
  SUBDIR += cyrus-imapd24
  SUBDIR += cyrus2courier
 +SUBDIR += cyrus2dovecot
  SUBDIR += davmail
  SUBDIR += dbmail
  SUBDIR += dbmail22
 
 Added: head/mail/cyrus2dovecot/Makefile
 ==
 --- /dev/null  00:00:00 1970   (empty, because file is newly added)
 +++ head/mail/cyrus2dovecot/Makefile   Tue Jul 23 20:35:11 2013
(r323548)
 @@ -0,0 +1,35 @@
 +# Created by: Vladimir Kondratiev 
 +# $FreeBSD$
 +
 +PORTNAME= cyrus2dovecot
 +PORTVERSION=  1.2
 +CATEGORIES=   mail
 +MASTER_SITES= http://www.cyrus2dovecot.sw.fu-berlin.de/download/
 +EXTRACT_SUFX=
 +EXTRACT_ONLY=
 +
 +MAINTAINER=   w...@mail.mipt.ru
 +COMMENT=  Convert Cyrus folders to Dovecot
 +
 +PLIST_FILES=  bin/${PORTNAME}
 +MAN1= ${PORTNAME}.1
 +
 +USE_PERL5=yes
 +NO_WRKSUBDIR= yes
 +
 +post-extract:
 +  @${CP} -v ${DISTDIR}/${DISTNAME} ${WRKSRC}
 +
 +post-patch:
 +  @${REINPLACE_CMD} -e '1s,^#!.*,#!${PERL},' ${WRKSRC}/${DISTNAME}
 +
 +do-build:
 +  pod2man --section=1 --release=${PORTVERSION} \
 +  --name=${PORTNAME} --center=${PORTNAME}" user guide" \
 +  ${WRKSRC}/${DISTNAME} ${WRKSRC}/${PORTNAME}.1
 +
 +do-install:
 +  ${INSTALL_SCRIPT} ${WRKSRC}/${DISTNAME} ${PREFIX}/bin/${PORTNAME}
 +  ${INSTALL_MAN} ${WRKSRC}/${PORTNAME}.1 ${PREFIX}/man/man1/${PORTNAME}.1
 +
 +.include 
 
 Added: head/mail/cyrus2dovecot/distinfo
 ==
 --- /dev/null  00:00:00 1970   (empty, because file is newly added)
 +++ head/mail/cyrus2dovecot/distinfo   Tue Jul 23 20:35:11 2013
(r323548)
 @@ -0,0 +1,2 @@
 +SHA256 (cyrus2dovecot-1.2) = 
69cc05e7d493b8e5030300aaa71bb87f72203f507ad726d796235619efae4917
 +SIZE (cyrus2dovecot-1.2) = 52212
 
 Added: head/mail/cyrus2dovecot/pkg-descr
 ==
 --- /dev/null  00:00:00 1970   (empty, because file is newly added)
 +++ head/mail/cyrus2dovecot/pkg-descr  Tue Jul 23 20:35:11 2013
(r323548)
 @@ -0,0 +1,6 @@
 +Cyrus2Dovecot is a full-featured command line tool for converting the
 +e-mails of one or more users from Cyrus format to Dovecot Maildir++ folders.
 +It allows for performing a server transition which is fully transparent to
 +both POP and IMAP users.
 +
 +WWW: http://www.cyrus2dovecot.sw.fu-berlin.de/
 ___
 svn-ports-...@freebsd.org mailing list
 http://lists.freebsd.org/mailman/listinfo/svn-ports-all
 To unsubscribe, send any mail to "svn-ports-all-unsubscr...@freebsd.org"
 
___
freebsd-doc@freebsd.org mailing list
http://lists.freebsd.org/mailman/listinfo/freebsd-doc
To unsubscribe, send any mail to "freebsd-doc-unsubscr...@freebsd.org"


Re: docs/180767: [man][libc] printf.3: fix off-by-one in snprintf description

2013-07-23 Thread Benjamin Kaduk
The following reply was made to PR docs/180767; it has been noted by GNATS.

From: Benjamin Kaduk 
To: bug-follo...@freebsd.org
Cc:  
Subject: Re: docs/180767: [man][libc] printf.3: fix off-by-one in snprintf
 description
Date: Tue, 23 Jul 2013 17:07:02 -0400 (EDT)

 On Tue, 23 Jul 2013, Dmitry Marakasov wrote:
 
 >
 >
 >> Description:
 > printf(3) says for snprintf:
 >
 > The snprintf() and vsnprintf() functions will write at most size-1 of the
 > characters printed into the output string (the size'th character then
 > gets the terminating `\0');
 >
 > the part in parenteses is incorrect: size'th character is outside
 > buffer of [size] characters. It should instead say "(size-1)'th
 > character" (which is last in the buffer).
 
 I think one could argue either way.  The character with index (size-1) 
 gets the NUL byte, but if one says that the first character is the one 
 with index 0, then it is in fact the size'th character which receives the 
 NUL.
 
 -Ben Kaduk
___
freebsd-doc@freebsd.org mailing list
http://lists.freebsd.org/mailman/listinfo/freebsd-doc
To unsubscribe, send any mail to "freebsd-doc-unsubscr...@freebsd.org"


Re: CFR: documentation rendered in PDF with FOP

2013-07-23 Thread Warren Block

On Tue, 23 Jul 2013, Gabor Kovesdan wrote:

I'm working on new rendering solutions for our documentation. One renderer 
will be dblatex, which doesn't depend on Java but doesn't give such high 
quality output. The other one will be FOP, which is written is Java but 
produces better quality.


Here are some PDFs for review, rendered with Apache FOP:
http://kovesdan.org/files/fop/

I need suggestions for royalty-free print-quality Bengali, Greek and Cyrillic 
fonts since these are still not customized and the default fonts lack 
non-Latin glyphs.


Apart from this, any comments are welcome. I know some parts still need 
improvements but feel free to comment on anything you think that should be 
changed.


Thanks for your work on this!

In a quick look, I did not notice any obvious problems.  What are the 
quality problems with dblatex?

___
freebsd-doc@freebsd.org mailing list
http://lists.freebsd.org/mailman/listinfo/freebsd-doc
To unsubscribe, send any mail to "freebsd-doc-unsubscr...@freebsd.org"


Re: CFR: documentation rendered in PDF with FOP

2013-07-23 Thread Warren Block

On Tue, 23 Jul 2013, Gabor Kovesdan wrote:


Hi,

I'm working on new rendering solutions for our documentation. One renderer 
will be dblatex, which doesn't depend on Java but doesn't give such high 
quality output. The other one will be FOP, which is written is Java but 
produces better quality.


Here are some PDFs for review, rendered with Apache FOP:
http://kovesdan.org/files/fop/

I need suggestions for royalty-free print-quality Bengali, Greek and Cyrillic 
fonts since these are still not customized and the default fonts lack 
non-Latin glyphs.


Apart from this, any comments are welcome. I know some parts still need 
improvements but feel free to comment on anything you think that should be 
changed.


There is something weird about bulleted lists and sub-lists, starting on 
page 35 of the PDF Handbook (page 7-9 of the content).  Some entries in 
the first list are blank, the ones in the second list have an extra 
linefeed after the bullet.

___
freebsd-doc@freebsd.org mailing list
http://lists.freebsd.org/mailman/listinfo/freebsd-doc
To unsubscribe, send any mail to "freebsd-doc-unsubscr...@freebsd.org"


Re: CFR: documentation rendered in PDF with FOP

2013-07-23 Thread Warren Block
The line-wrap characters are very welcome!  They still need some tuning 
(see PDF page 26).  Or maybe that's in the source XML, but it's good to 
see a start on that!

___
freebsd-doc@freebsd.org mailing list
http://lists.freebsd.org/mailman/listinfo/freebsd-doc
To unsubscribe, send any mail to "freebsd-doc-unsubscr...@freebsd.org"


Re: CFR: documentation rendered in PDF with FOP

2013-07-23 Thread Michael Ross
On Tue, 23 Jul 2013 15:38:24 +0200, Gabor Kovesdan  
 wrote:



Hi,

I'm working on new rendering solutions for our documentation. One  
renderer will be dblatex, which doesn't depend on Java but doesn't give  
such high quality output. The other one will be FOP, which is written is  
Java but produces better quality.


Here are some PDFs for review, rendered with Apache FOP:
http://kovesdan.org/files/fop/

I need suggestions for royalty-free print-quality Bengali, Greek and  
Cyrillic fonts since these are still not customized and the default  
fonts lack non-Latin glyphs.


Apart from this, any comments are welcome. I know some parts still need  
improvements but feel free to comment on anything you think that should  
be changed.


Gabor



Hello,

I just skimmed through the pdf of the german version of the developer's  
handbook and noticed some problems with syllabification at the end of  
lines.


Examples:
filename "fromboz.c" printed as
from-
boz.c

"/usr/share/mk" printed as
/
share/mk

"Option -o" printed as
Option -
o

From the english version:
"" printed as


Plus, in some paragraphs nearly all lines end with a hyphen; I think that  
makes the whole hard to read.


If possible, I would turn syllabification off altogether.


Regards,

Michael
___
freebsd-doc@freebsd.org mailing list
http://lists.freebsd.org/mailman/listinfo/freebsd-doc
To unsubscribe, send any mail to "freebsd-doc-unsubscr...@freebsd.org"


Re: CFR: documentation rendered in PDF with FOP

2013-07-23 Thread Gabor Kovesdan

On 2013.07.23. 23:11, Warren Block wrote:


Thanks for your work on this!

In a quick look, I did not notice any obvious problems.  What are the 
quality problems with dblatex? 

- Customization is more complicated.
- Overall outlook just doesn't look so nice. That may be improved by 
customization but that's not so trivial.
- It doesn't support programlistings in lists and several documents 
still fail because of this.
- Somehow it doesn't properly wrap non-Latin text: 
http://kovesdan.org/files/tex-ja.pdf
  Maybe it is trivial to fix, I just don't know how CJK text is handled 
in TeX. But I don't understand why something so trivial doesn't just 
work out of the box.


There is something weird about bulleted lists and sub-lists, starting 
on page 35 of the PDF Handbook (page 7-9 of the content).  Some 
entries in the first list are blank, the ones in the second list have 
an extra linefeed after the bullet. 
It is a known issue and is actually the result of misplaced indexterms, 
not a bug in the rendering. I've already fixed some of them in the 
English docs but translations still has to be fixed and there may be 
slightly different cases, which I haven't caught yet. We should document 
in fdp-primer that indexterms should be put right inside of the text 
after the referred word. Not between paragraphs, not into 
, not into  but right inside  after the 
referred word without leaving a single a space. If they are not in 
, it can cuase such problems. And if you put a space before the 
indexterm, there may be a page break and you get a wrong page number in 
the index. But the probability of this latter is very low, the former 
thing is more important.


The line-wrap characters are very welcome! They still need some tuning 
(see PDF page 26).  Or maybe that's in the source XML, but it's good 
to see a start on that! 
Yes, I've also noticed that that page is quite weird. The line-wrap part 
should be easy to fix, we just have to add the comma as a possible 
wrapping character. It is stranger why the text overflows instead of 
causing a page break. The good thing is that the output of the renderer 
is very clean and we can clearly see which pages have overflows.


Gabor
___
freebsd-doc@freebsd.org mailing list
http://lists.freebsd.org/mailman/listinfo/freebsd-doc
To unsubscribe, send any mail to "freebsd-doc-unsubscr...@freebsd.org"


Re: CFR: documentation rendered in PDF with FOP

2013-07-23 Thread Gabor Kovesdan

On 2013.07.23. 23:55, Michael Ross wrote:
I just skimmed through the pdf of the german version of the 
developer's handbook and noticed some problems with syllabification at 
the end of lines.


Examples:
filename "fromboz.c" printed as
from-
boz.c
Do you think filenames and such should not be hyphenated at all? I've 
been thinking of it but that may sometimes result in weird spacing 
because of the justification.


"/usr/share/mk" printed as
/
share/mk

"Option -o" printed as
Option -
o

From the english version:
"" printed as


Plus, in some paragraphs nearly all lines end with a hyphen; I think 
that makes the whole hard to read.


If possible, I would turn syllabification off altogether. 
Hyphenation can still be improved and actually it is a requirement for 
printed publications. With hyphenation, justification works better and 
text should have a more pleasant outlook. We can tweak the dictionaries 
to avoid hyphenating the word FreeBSD and such. And as a last resort, we 
can still easily turn it off if we are not satisfied with the result. 
The rendering is still a work in progress. I'll see what I can do here.


Gabor
___
freebsd-doc@freebsd.org mailing list
http://lists.freebsd.org/mailman/listinfo/freebsd-doc
To unsubscribe, send any mail to "freebsd-doc-unsubscr...@freebsd.org"


screen elements and userinput in XHTML

2013-07-23 Thread Warren Block
In XHTML documents, our current CSS stylesheet does not distinguish 
between user-typed input and system output.  That's my fault, Gabor had 
user input in bold but I felt it had so much contrast that it distracted 
rather than clarified.  Our screen elements are not separated from other 
text, either.


The current programlisting elements are better, in a box with a gray 
background.  We could make screen elements identical, but there is some 
value to the reader in making them look different.


I checked various web documentation pages for other projects, and most 
did not distinguish between system output and user input.  In some 
cases, that is likely to prompt a user to type a prompt.  The 
best-looking example I found was some Slackware documentation, which 
uses plain text for system output and bold for user input, but put it on 
a gray background which helped tone down the contrast.


Putting this all together, I've been trying this experimental addition 
to doc/share/misc/docbook.css.  It makes the userinput bold, draws a box 
around screen elements, but uses a sort of medium tan background so it 
does not look like a programlisting.


The color is questionable, and there may be a better choice.  Lighter 
colors seemed too bright.  But I do find this easier to read.


Comments welcome.


Index: docbook.css
===
--- docbook.css (revision 42404)
+++ docbook.css (working copy)
@@ -240,6 +240,10 @@
white-space: pre;
font-family: monospace;
padding: 1ex;
+   background-color: #ec8;
+   border: 1px solid #ccc;
+   border-radius: 6px;
+   line-height: 1.1;
 }

 div.programlisting {
@@ -340,7 +344,7 @@
 }

 .userinput {
-   font-weight: normal;
+   font-weight: bold;
 }

 pre.screen strong {Index: docbook.css
===
--- docbook.css (revision 42404)
+++ docbook.css (working copy)
@@ -240,6 +240,10 @@
white-space: pre;
font-family: monospace;
padding: 1ex;
+   background-color: #ec8;
+   border: 1px solid #ccc;
+   border-radius: 6px;
+   line-height: 1.1;
 }
 
 div.programlisting {
@@ -340,7 +344,7 @@
 }
 
 .userinput {
-   font-weight: normal;
+   font-weight: bold;
 }
 
 pre.screen strong {
___
freebsd-doc@freebsd.org mailing list
http://lists.freebsd.org/mailman/listinfo/freebsd-doc
To unsubscribe, send any mail to "freebsd-doc-unsubscr...@freebsd.org"

Re: CFR: documentation rendered in PDF with FOP

2013-07-23 Thread Warren Block

On Wed, 24 Jul 2013, Gabor Kovesdan wrote:


On 2013.07.23. 23:11, Warren Block wrote:

There is something weird about bulleted lists and sub-lists, starting on 
page 35 of the PDF Handbook (page 7-9 of the content).  Some entries in the 
first list are blank, the ones in the second list have an extra linefeed 
after the bullet. 
It is a known issue and is actually the result of misplaced indexterms, not a 
bug in the rendering. I've already fixed some of them in the English docs but 
translations still has to be fixed and there may be slightly different cases, 
which I haven't caught yet. We should document in fdp-primer that indexterms 
should be put right inside of the text after the referred word. Not between 
paragraphs, not into , not into  but right inside 
 after the referred word without leaving a single a space. If they are 
not in , it can cuase such problems. And if you put a space before the 
indexterm, there may be a page break and you get a wrong page number in the 
index. But the probability of this latter is very low, the former thing is 
more important.


Presently, indexes and indeterms are not even mentioned in the FDPP. 
I'll start a list of things to add after the doc slush.  If you or 
anyone else have found things which are not documented well or at all in 
the FDPP, please let me know or enter a PR.

___
freebsd-doc@freebsd.org mailing list
http://lists.freebsd.org/mailman/listinfo/freebsd-doc
To unsubscribe, send any mail to "freebsd-doc-unsubscr...@freebsd.org"