docs December 2005

docs@lists.fedoraproject.org

13 participants
25 discussions

Minutes of FDSCo Meeting Dec 13 2005
by Stuart Ellis 14 Dec '05

14 Dec '05

Attending: --------- Karsten Wade (quaid) Tommy Reynolds (megacoder) Gavin Henry (G2) Tammy Fox (tcf_home) Stuart Ellis (elliss) Regrets: -------- Paul Frields (stickster) Schedule of Tasks: ------------------ http://www.fedoraproject.org/wiki/DocsProject/FedoraDocsSchedule Highlights: ----------- * Karsten: Discussion of possible DocsRawHide enhancements. Useful developments might include: e-mail build errors to document maintainers, building of branches other than the current branch, listing of documents on Fedora Project website(s). * Tommy: Currently working on the handling of images in the document build process. * Tommy: Documentation Guide to be updated to match current build processes. * Karsten: There are still open slots for Release Note beats. An e-mail will be sent out to request a writer for the Legacy beat, and for writers to cover a new Extras beat. Other open slots: Kernel, File Systems, Development Tools, Samba, System Daemons, x86-specific content, x86_64-specific content, Database Servers, and Backwards Compatibility. Full IRC Log: ------------- https://www.redhat.com/archives/fedora-dsco-list/2005-December/msg00004.html -- Stuart Ellis stuart(a)elsn.org Fedora Documentation Project: http://fedora.redhat.com/projects/docs/ GPG key ID: 7098ABEA GPG key fingerprint: 68B0 E291 FB19 C845 E60E 9569 292E E365 7098 ABEA

1 0

[RFC] Image filename conventions
by Tommy Reynolds 13 Dec '05

13 Dec '05

Hello, ya'll! Some folk have their document images in a "figs/" subdirectory tree under the document directory. Large documents may have additional "figs/part1" style subdirectories, too. The lack of a formal filenaming scheme makes selectively copying files awkward. Below is our current convention: <filename>-<locale>.<ext> such as "watermark-ru.png". Simple, eh? The problem is that some filenames use the "-" minus sign to separate words in the filename: this-is-my-picture.png Is "picture" part of the filename or the language designation? It is difficult for a shell script to decode this just by looking at the filename. I propose a file naming scheme to simplify the selective copying of files. This will help reduce the complexity of the RPM packaging tools. Only three formal rules are needed: 1) The minus sign "-" may not be used as part of the filename component. 1) The minus sign only introduces the locale for the file. 1) Filenames without a locale component are considered language neutral. With these conventions in place: "foo.png" is a language-neutral graphic. "foo-it.png" is a graphic with Italian text. "foo-bar.png" is not permitted usage. Comments? Alternatives? Bribes? Cheers

3 9

Documentation Guide Chapter 9
by Tommy Reynolds 12 Dec '05

12 Dec '05

The current Documentation Guide Chapter 9 "Converting to HTML and PDF" is insufficient. Does any one mind if I update it? Cheers

2 1

Re: docs-common/images Makefile, 1.5, 1.6 watermark-de.png, 1.1, 1.2 watermark-en.png, 1.1, 1.2 watermark-it.png, 1.1, 1.2 watermark-ja_JP.png, 1.1, 1.2 watermark-ru.png, 1.1, 1.2 watermark-zh_CN.png, 1.1, 1.2 watermark-zh_CN.svg, 1.1, 1.2
by Yuan Yijun 11 Dec '05

11 Dec '05

2005/12/10, jtr Tommy Reynolds <fedora-docs-commits(a)redhat.com>: > - <text font-family="AR PL ZenKai Uni" font-stretch="wider" text-anchor="middle" x="0" y="0">文档草案</text> > + <text font-family="'AR PL ZenKai Uni'" font-stretch="wider" text-anchor="middle" x="0" y="0">文档草案</text> could you please explain it? -- bbbush ^_^

2 6

zh_CN watermark added
by Tommy Reynolds 10 Dec '05

10 Dec '05

bbbush, Thank you for submitting the watermark-zh_CN.* files. I'm having trouble recreating the .PNG, though. Forgive my ignorance on this matter. Where can I find the font "AR PL ZenKai Uni"? Is that a standard Fedora font? If so, from what package? Thanks!

2 1

relnotes XML in CVS is now canonical
by Karsten Wade 10 Dec '05

10 Dec '05

For a short while, we used the Wiki as the canonical resource for release notes, until snapshots were taken for specific releases. Those pages [1] continue to hold very current content, but it is truly draft information. With the creation of the DocsRawhide [2], we can now show the latest build from CVS directly. This removes the need to use the convenience of the Wiki to show content to readers. For now, integration of content between the Wiki and the XML is done semi-manually. This means that the Wiki may have updated information, but it is not reliable until it is in the XML in CVS. Thanks - Karsten [1] http://fedoraproject.org/wiki/Docs/Beats [2] http://webtest.fedora.redhat.com/docs/ is the beta home -- Karsten Wade, RHCE * Sr. Tech Writer * http://people.redhat.com/kwade/ gpg fingerprint: 2680 DBFD D968 3141 0115 5F1B D992 0E06 AD0E 0C41 Content Services Fedora Documentation Project http://www.redhat.com/docs http://fedoraproject.org/wiki/DocsProject

1 0

Re: [ANN] Draft Document Rendering
by Tommy Reynolds 10 Dec '05

10 Dec '05

Uttered Francesco Tombolini <tombo(a)adamantio.net>, spake thus: > Hallo Tommy, the translation for "DRAFT / NOT FOR > REFERENCE" notation in italian language is "BOZZA / NON PER RIFERIMENTO" Thank you, Francesco. I've added it to CVS. Ciao

1 0

[ANN] Draft Document Rendering
by Tommy Reynolds 09 Dec '05

09 Dec '05

Hi, Folks! Unless you are involved, or interested in, the Fedora Doc publishing infrastructure you can skip this but you're welcome to stay. We are keeping the default behaviour of watermarking the HTML documents produced from the CVS files as "DRAFT / NOT FOR REFERENCE". Per the discussion and suggestions on this list, I've made using different CSS stylesheets much easier. This should allow a batch building process to choose, at rendering time, which CSS stylesheet to use. Two new "docs-common/Makefile.common" macros have been added: ${HTMLCSS} should contain the path to whatever CSS stylesheet should be used. ${HTMLCSSEXTRA} should list any additional files needed by the CSS stylesheet, such as the "images/watermark.png" file used by the default stylesheet. Currently there are several ways of specifying any of the "docs-common/Makefile.common" macros: 1) Do nothing and accept the default values coded in "docs-common/Makefile.common". 2) Add the definitions at the top of the document "Makefile". This is NOT recommended. 3) Create the file "Make.paths" in the document directory and place the macro definitions in there, just as if they were part of "docs-common/Makefile.common". 4) Export the macro definitions into your environment before doing the make. 5) Define the macro on the make command line: $ make HTMLCSS=/path/to/my.css html For now, I recommend either method #3 or #5, depending on how many times you need to build the document. As always, suggestions, comments and bribes are cheerfully accepted. Cheers

2 3

latest relnotes updated, now with it and ru versions
by Karsten Wade 08 Dec '05

08 Dec '05

The latest relnotes for FC5test1 have been updated: http://fedora.redhat.com/docs/release-notes/ Update features: * Italian (it) and Russian (ru) translations are now updated as latest, since these have been updated since the test1 translation freeze. * The [Tip] at the top of the release notes now links to a Wiki page of updated common problems; note this only appears in the English version of the [Tip]: http://fedoraproject.org/wiki/FC5Test1CommonProblems If you are interested in watching the tip of the creation process for the relnotes, put a watch on the beats pages in the Wiki with this regular expression: 1. Go to http://fedoraproject.org/wiki/UserPreferences 2. In the Subscribed wiki pages (one regex per line) field at the bottom of page, put in this regular expression: Docs/Beats.* http://fedoraproject.org/wiki/Docs/Beats Thanks beat writers, editors, and translators for providing Fedora testers with updated content. - Karsten -- Karsten Wade, RHCE * Sr. Tech Writer * http://people.redhat.com/kwade/ gpg fingerprint: 2680 DBFD D968 3141 0115 5F1B D992 0E06 AD0E 0C41 Content Services Fedora Documentation Project http://www.redhat.com/docs http://fedoraproject.org/wiki/DocsProject

1 0

[RFC] DocsRawhide enhancements
by Karsten Wade 07 Dec '05

07 Dec '05

The DocsRawhide (rawhide of documentation) beta has been live for a little while: http://webtest.fedora.redhat.com/docs/ There are many purposes this basic technology can be used for. At it's core, it checks out the latest content from CVS and builds it at static URLs. This is fully draft, may burn your computer documentation. It's purpose is to let anyone view what is in CVS without needing a build environment. What are your ideas of what to do with this tool? What should we make it do? - Karsten -- Karsten Wade, RHCE * Sr. Tech Writer * http://people.redhat.com/kwade/ gpg fingerprint: 2680 DBFD D968 3141 0115 5F1B D992 0E06 AD0E 0C41 Content Services Fedora Documentation Project http://www.redhat.com/docs http://fedoraproject.org/wiki/DocsProject

3 4

2024

2023

2022

2021

2020

2019

2018

2017

2016

2015

2014

2013

2012

2011

2010

2009

2008

2007

2006

2005

2004

2003

2002

docs December 2005