From kwade at redhat.com Thu Jun 4 22:12:13 2015 Content-Type: multipart/mixed; boundary="===============4843963729826288264==" MIME-Version: 1.0 From: Karsten Wade To: docs at lists.fedoraproject.org Subject: h1 in Wiki Date: Fri, 02 Mar 2007 00:31:19 -0800 Message-ID: <1172824279.4651.516.camel@erato.phig.org> --===============4843963729826288264== Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: quoted-printable I've lost track of what we want to appear as a primary header (h1) on a Wiki page. That is, we sometimes use this: {{{#!html

Page Title

}}} Is this strictly for visual affect? In the case of the Docs/Beats, I think we need to stick to a strict usage of each page having only one h1 and all other content being a sub: =3D Page Title =3D =3D=3D A Section =3D=3D =3D=3D=3D Sub-section A =3D=3D=3D =3D=3D=3D Sub-section B =3D=3D=3D =3D=3D Another Section =3D=3D According to this page: http://fedoraproject.org/wiki/DocsProject/WritingUsingTheWiki ... that is our method. Seem reasonable? - Karsten -- = Karsten Wade, RHCE, 108 Editor ^ Fedora Documentation Project = Sr. Developer Relations Mgr. | fedoraproject.org/wiki/DocsProject quaid.108.redhat.com | gpg key: AD0E0C41 ////////////////////////////////// \\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\ --===============4843963729826288264== Content-Type: application/pgp-signature MIME-Version: 1.0 Content-Transfer-Encoding: base64 Content-Disposition: attachment; filename="signature.asc" LS0tLS1CRUdJTiBQR1AgU0lHTkFUVVJFLS0tLS0KVmVyc2lvbjogR251UEcgdjEuNC42IChHTlUv TGludXgpCgppRDhEQlFCRjUrRFgyWklPQnEwT0RFRVJBamlnQUtDdktUM0cvcWY4MGhoUnlwdHg1 S0ZWTVk2N3pRQ2RINXNQClJpZ1dpcFVnbVhsendnSG41aDExWThrPQo9VW0vZQotLS0tLUVORCBQ R1AgU0lHTkFUVVJFLS0tLS0K --===============4843963729826288264==-- From dimitris at glezos.com Thu Jun 4 22:12:14 2015 Content-Type: multipart/mixed; boundary="===============4873605455416754720==" MIME-Version: 1.0 From: Dimitris Glezos To: docs at lists.fedoraproject.org Subject: Re: h1 in Wiki Date: Fri, 02 Mar 2007 15:33:14 +0000 Message-ID: <45E843BA.80802@glezos.com> In-Reply-To: 1172824279.4651.516.camel@erato.phig.org --===============4873605455416754720== Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: quoted-printable O/H Karsten Wade =CE=AD=CE=B3=CF=81=CE=B1=CF=88=CE=B5: > I've lost track of what we want to appear as a primary header (h1) on a > Wiki page. That is, we sometimes use this: > = > {{{#!html >

Page Title

}}} > = > Is this strictly for visual affect? The above is the same as `=3D=3D Page Title =3D=3D`, so we could just strip= the obfuscation and use the syntax. After ``, `<h1>` is the most important heading. On the wiki, I belie= ve the correct way to use it would be a title-style description of the page. Something like a more decriptive of the pagename. For example: /DocsProject has: =3D The Documentation Project =3D In general, only one h1 should exist on a page, unless the page contents ar= e so disorganized that cannot fit under one category. This does not apply to our= wiki though (we just split the page in two if this happens). > In the case of the Docs/Beats, I think we need to stick to a strict > usage of each page having only one h1 and all other content being a sub: > = > =3D Page Title =3D > = > =3D=3D A Section =3D=3D > ... Correct. The way I see best a wiki page to be structured is shown below. Of course, = Beats don't have a TOC or breadcrumbs. > You are here: Home > Foo > Bar< > = > =3D Page title similar to page name =3D > = > Some text describing the page. No more than 3 paragraphs, no less than on= e. > = > [TableOfContents] > = > =3D=3D Foo section =3D=3D > = > Text that describes/introduces the content of Foo section. > = > =3D=3D=3D Subsection =3D=3D=3D > = > ... > > ---- > CategoryFoo -d -- = Dimitris Glezos Jabber ID: glezos(a)jabber.org, GPG: 0xA5A04C3B http://dimitris.glezos.com/ "He who gives up functionality for ease of use loses both and deserves neither." (Anonymous) -- = --===============4873605455416754720==-- From stickster at gmail.com Thu Jun 4 22:12:14 2015 Content-Type: multipart/mixed; boundary="===============8679932469346581045==" MIME-Version: 1.0 From: Paul W. Frields <stickster at gmail.com> To: docs at lists.fedoraproject.org Subject: Re: h1 in Wiki Date: Fri, 02 Mar 2007 12:49:56 -0500 Message-ID: <1172857796.14117.9.camel@localhost.localdomain> In-Reply-To: 45E843BA.80802@glezos.com --===============8679932469346581045== Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: quoted-printable On Fri, 2007-03-02 at 15:33 +0000, Dimitris Glezos wrote: > O/H Karsten Wade =CE=AD=CE=B3=CF=81=CE=B1=CF=88=CE=B5: > > I've lost track of what we want to appear as a primary header (h1) on a > > Wiki page. That is, we sometimes use this: > > = > > {{{#!html > > <h2>Page Title</h2>}}} > > = > > Is this strictly for visual affect? > = > The above is the same as `=3D=3D Page Title =3D=3D`, so we could just str= ip the > obfuscation and use the syntax. It's not necessarily obfuscation -- the point is not the appearance, but rather how it gets converted to DocBook. To find out the effects, try converting a Beats page to DocBook and see how the sectioning using '=3D', '=3D=3D', etc. changes the resulting markup. The end goal in converting the Beats is for each Beat to be a file containing a top-level <section>, all of which are XIncludes in the parent <article> file. Before we declare a standard here, check to see what it implies for the conversion process and how much more editing is required to get the resulting file in shape for publication. I remember having to deal with this several times, and unfortunately I took crappy (meaning "no") notes on the right and wrong ways of doing this. -- = Paul W. Frields, RHCE http://paul.frields.org/ gpg fingerprint: 3DA6 A0AC 6D58 FEC4 0233 5906 ACDB C937 BD11 3717 Fedora Project: http://fedoraproject.org/wiki/PaulWFrields irc.freenode.net: stickster @ #fedora-docs, #fedora-devel, #fredlug --===============8679932469346581045== Content-Type: application/pgp-signature MIME-Version: 1.0 Content-Transfer-Encoding: base64 Content-Disposition: attachment; filename="signature.asc" LS0tLS1CRUdJTiBQR1AgU0lHTkFUVVJFLS0tLS0KVmVyc2lvbjogR251UEcgdjEuNC42IChHTlUv TGludXgpCgppRDREQlFCRjZHUEVyTnZKTjcwUk54Y1JBazVEQUtDK0JqalJTd3FzaGVESVNGMFRo d2xKNTBuNmVBQ1ZGQWVDCmxPN1hNM0NGeHRRMHNoc1dXWWpFbmc9PQo9SVlrLwotLS0tLUVORCBQ R1AgU0lHTkFUVVJFLS0tLS0K --===============8679932469346581045==-- From paulo.banon at googlemail.com Thu Jun 4 22:12:16 2015 Content-Type: multipart/mixed; boundary="===============5567322443061223924==" MIME-Version: 1.0 From: Paulo Santos <paulo.banon at googlemail.com> To: docs at lists.fedoraproject.org Subject: Re: h1 in Wiki Date: Fri, 02 Mar 2007 09:52:45 +0100 Message-ID: <7a41c4bc0703020052jc3599fat811262f195a97dc2@mail.gmail.com> In-Reply-To: 1172824279.4651.516.camel@erato.phig.org --===============5567322443061223924== Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: quoted-printable Karsten, If i'm not mistaken the =3D h1 =3D or even =3D=3Dh2 =3D=3D didn't work well= in the previous version of Moin. Right now that should be fixed, so yes, i think you guys should follow the guidelines already defined by FDP. Paulo On 3/2/07, Karsten Wade <kwade(a)redhat.com> wrote: > > I've lost track of what we want to appear as a primary header (h1) on a > Wiki page. That is, we sometimes use this: > > {{{#!html > <h2>Page Title</h2>}}} > > Is this strictly for visual affect? > > In the case of the Docs/Beats, I think we need to stick to a strict > usage of each page having only one h1 and all other content being a sub: > > =3D Page Title =3D > > =3D=3D A Section =3D=3D > > =3D=3D=3D Sub-section A =3D=3D=3D > > =3D=3D=3D Sub-section B =3D=3D=3D > > =3D=3D Another Section =3D=3D > > According to this page: > > http://fedoraproject.org/wiki/DocsProject/WritingUsingTheWiki > > ... that is our method. > > Seem reasonable? > > - Karsten > -- > Karsten Wade, RHCE, 108 Editor ^ Fedora Documentation Project > Sr. Developer Relations Mgr. | fedoraproject.org/wiki/DocsProject > quaid.108.redhat.com | gpg key: AD0E0C41 > ////////////////////////////////// \\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\ > > -- > fedora-docs-list mailing list > fedora-docs-list(a)redhat.com > To unsubscribe: > https://www.redhat.com/mailman/listinfo/fedora-docs-list > > --===============5567322443061223924== Content-Type: text/html MIME-Version: 1.0 Content-Transfer-Encoding: base64 Content-Disposition: attachment; filename="attachment.html" S2Fyc3Rlbiw8YnI+PGJyPklmIGkmIzM5O20gbm90IG1pc3Rha2VuIHRoZSA9IGgxID0gb3IgZXZl biA9PWgyID09IGRpZG4mIzM5O3Qgd29yayB3ZWxsIGluIHRoZSBwcmV2aW91cyB2ZXJzaW9uIG9m IE1vaW4uPGJyPlJpZ2h0IG5vdyB0aGF0IHNob3VsZCBiZSBmaXhlZCwgc28geWVzLCBpIHRoaW5r IHlvdSBndXlzIHNob3VsZCBmb2xsb3cgdGhlIGd1aWRlbGluZXMgYWxyZWFkeSBkZWZpbmVkIGJ5 IEZEUC4KPGJyPjxicj48YnI+UGF1bG88YnI+PGJyPjxkaXY+PHNwYW4gY2xhc3M9ImdtYWlsX3F1 b3RlIj5PbiAzLzIvMDcsIDxiIGNsYXNzPSJnbWFpbF9zZW5kZXJuYW1lIj5LYXJzdGVuIFdhZGU8 L2I+ICZsdDs8YSBocmVmPSJtYWlsdG86a3dhZGVAcmVkaGF0LmNvbSI+a3dhZGVAcmVkaGF0LmNv bTwvYT4mZ3Q7IHdyb3RlOjwvc3Bhbj48YmxvY2txdW90ZSBjbGFzcz0iZ21haWxfcXVvdGUiIHN0 eWxlPSJib3JkZXItbGVmdDogMXB4IHNvbGlkIHJnYigyMDQsIDIwNCwgMjA0KTsgbWFyZ2luOiAw cHQgMHB0IDBwdCAwLjhleDsgcGFkZGluZy1sZWZ0OiAxZXg7Ij4KSSYjMzk7dmUgbG9zdCB0cmFj ayBvZiB3aGF0IHdlIHdhbnQgdG8gYXBwZWFyIGFzIGEgcHJpbWFyeSBoZWFkZXIgKGgxKSBvbiBh PGJyPldpa2kgcGFnZS4mbmJzcDsmbmJzcDtUaGF0IGlzLCB3ZSBzb21ldGltZXMgdXNlIHRoaXM6 PGJyPjxicj57e3sjIWh0bWw8YnI+Jmx0O2gyJmd0O1BhZ2UgVGl0bGUmbHQ7L2gyJmd0O319fTxi cj48YnI+SXMgdGhpcyBzdHJpY3RseSBmb3IgdmlzdWFsIGFmZmVjdD88YnI+Cjxicj5JbiB0aGUg Y2FzZSBvZiB0aGUgRG9jcy9CZWF0cywgSSB0aGluayB3ZSBuZWVkIHRvIHN0aWNrIHRvIGEgc3Ry aWN0PGJyPnVzYWdlIG9mIGVhY2ggcGFnZSBoYXZpbmcgb25seSBvbmUgaDEgYW5kIGFsbCBvdGhl ciBjb250ZW50IGJlaW5nIGEgc3ViOjxicj48YnI+PSBQYWdlIFRpdGxlID08YnI+PGJyPj09IEEg U2VjdGlvbiA9PTxicj48YnI+PT09IFN1Yi1zZWN0aW9uIEEgPT09Cjxicj48YnI+PT09IFN1Yi1z ZWN0aW9uIEIgPT09PGJyPjxicj49PSBBbm90aGVyIFNlY3Rpb24gPT08YnI+PGJyPkFjY29yZGlu ZyB0byB0aGlzIHBhZ2U6PGJyPjxicj48YSBocmVmPSJodHRwOi8vZmVkb3JhcHJvamVjdC5vcmcv d2lraS9Eb2NzUHJvamVjdC9Xcml0aW5nVXNpbmdUaGVXaWtpIj5odHRwOi8vZmVkb3JhcHJvamVj dC5vcmcvd2lraS9Eb2NzUHJvamVjdC9Xcml0aW5nVXNpbmdUaGVXaWtpCjwvYT48YnI+PGJyPi4u LiB0aGF0IGlzIG91ciBtZXRob2QuPGJyPjxicj5TZWVtIHJlYXNvbmFibGU/PGJyPjxicj4tIEth cnN0ZW48YnI+LS08YnI+S2Fyc3RlbiBXYWRlLCBSSENFLCAxMDggRWRpdG9yJm5ic3A7Jm5ic3A7 Jm5ic3A7Jm5ic3A7XiZuYnNwOyZuYnNwOyZuYnNwOyZuYnNwOyBGZWRvcmEgRG9jdW1lbnRhdGlv biBQcm9qZWN0PGJyPiBTci4gRGV2ZWxvcGVyIFJlbGF0aW9ucyBNZ3IuJm5ic3A7Jm5ic3A7Jm5i c3A7Jm5ic3A7IHwmbmJzcDsmbmJzcDs8YSBocmVmPSJodHRwOi8vZmVkb3JhcHJvamVjdC5vcmcv d2lraS9Eb2NzUHJvamVjdCI+CmZlZG9yYXByb2plY3Qub3JnL3dpa2kvRG9jc1Byb2plY3Q8L2E+ PGJyPiZuYnNwOyZuYnNwOyA8YSBocmVmPSJodHRwOi8vcXVhaWQuMTA4LnJlZGhhdC5jb20iPnF1 YWlkLjEwOC5yZWRoYXQuY29tPC9hPiZuYnNwOyZuYnNwOyZuYnNwOyZuYnNwOyZuYnNwOyZuYnNw OyZuYnNwOyZuYnNwOyZuYnNwOyZuYnNwOyB8Jm5ic3A7Jm5ic3A7Jm5ic3A7Jm5ic3A7Jm5ic3A7 Jm5ic3A7Jm5ic3A7Jm5ic3A7Jm5ic3A7Jm5ic3A7Z3BnIGtleTogQUQwRTBDNDE8YnI+Ly8vLy8v Ly8vLy8vLy8vLy8vLy8vLy8vLy8vLy8vLy8vLyBcXFxcXFxcXFxcXFxcXFxcXFxcXFxcXFxcXFxc XFxcXFxcXFwKPGJyPjxicj4tLTxicj5mZWRvcmEtZG9jcy1saXN0IG1haWxpbmcgbGlzdDxicj48 YSBocmVmPSJtYWlsdG86ZmVkb3JhLWRvY3MtbGlzdEByZWRoYXQuY29tIj5mZWRvcmEtZG9jcy1s aXN0QHJlZGhhdC5jb208L2E+PGJyPlRvIHVuc3Vic2NyaWJlOjxicj48YSBocmVmPSJodHRwczov L3d3dy5yZWRoYXQuY29tL21haWxtYW4vbGlzdGluZm8vZmVkb3JhLWRvY3MtbGlzdCI+aHR0cHM6 Ly93d3cucmVkaGF0LmNvbS9tYWlsbWFuL2xpc3RpbmZvL2ZlZG9yYS1kb2NzLWxpc3QKPC9hPjxi cj48YnI+PC9ibG9ja3F1b3RlPjwvZGl2Pjxicj4K --===============5567322443061223924==--