UbuntuHelp:DocumentationTemplate/PageDiscussion

文章出处:

https://help.ubuntu.com/community/DocumentationTemplate/PageDiscussion

点击翻译:

English

请不要直接编辑翻译本页，本页将定期与来源同步。

This is the discussion page for: DocumentationTemplate Please sign your comments by pasting `@SI``G@` after them.

• Created this discussion page and finished a major revision of the template -- duncan-lithgow <<DateTime(2008-07-26T15:47:35+0200)>>
• I've simplified the page a bit, because it was a bit confusing. I've removed the references to page headers and page tags for now until they can be properly discussed. The idea of is a bit strange - I think you are confusing the concept of a parent with categories - a parent is simply the owner of a subpage, if a page doesn't have a parent, it doesn't need to be categorised. We need to discuss carefully the use of categories or we will end up having so many that they won't be very useful. I've also removed the idea of listing Contributors on the page, for the reasons described on the ubuntu-doc mailing list. -- mdke <<DateTime(2008-08-12T07:20:43Z)>>
• Thanks for cleaning that up a bit, it was a bit crowded. -- duncan-lithgow <<DateTime(2008-08-12T13:15:29+0200)>>
• I've added a bit of material and edited what's there a little. Hope it's OK. A few questions:
• Why is introduction a top-level heading, with sections 1, 2, and 3 as sub-sections of introduction? Shouldn't section 1, 2, and 3 all be top-level headings?
• Shouldn't the 'See also' and 'External links' headings be fully capitalised? 'See Also', 'External Links'.

-- -- allan.day <<DateTime(2008-08-12T17:09:15+0100)>>

• Allan, I agree with all you say there, yes:
• == Introduction ==
• == Section 1 ==
• === Subsections ===
• == Section 2 ==
• == See also == (or whatever we end up calling it)
• etc...
• But as for capitalisation, The gnome HIG says capitalize but Wikipedia says don't. I'm not sure what I prefer, I think in many ways un-capitalized is easier to read and less 'in your face' -- duncan-lithgow <<DateTime(2008-08-14T14:55:11+0200)>>
• About capitalisation - yes, I think my preference would be to just capitalise the first word. I asked about this on the ubuntu-doc list a little while ago, and Phil Bull advised that the doc team follow the GNOME style guide. Though it's not my personal favourite, I do think that, in order to get some consistency, it's worth following the GNOME guidelines on this occasion. -- allan.day <<DateTime(2008-08-14T14:39:37+0100)>>
• OK, so neither of us like it, but we agree to follow the HIG, better than reinventing everything I guess. From now on please just go ahead with anything that I don't object to within about two weeks. -- duncan-lithgow <<DateTime(2008-08-19T12:31:43+0200)>>
• Yes, I've changed it, and yes it looks a bit funny, but it does follow the guidelines now! Ordinarily, I wouldn't have waited, but this template is a bit of a special case. -- allan.day <<DateTime(2008-08-20T09:28:13+0100)>>
• I'm curious about the Table of Contents header at the top of each page. This is how the code for the header is shown on the DocumentationTemplate page:

If you look at the Table of Contents on that page (and any page that uses that code), you will see "Contents" shown twice. If you use this code instead, "Contents" will only be shown once:

Is it okay to do this? -- littlergirl <<DateTime(2008-09-23T20:53:47+0100)>>

• RE: Table of Contents

The Table of Contents include function used to not actually include the "Table of Contents" text, but that was changed a few months ago. That page simply has not been updated (I guess the script missed that page, I'll fix it now). Your second entry is exactly right. =D -- LaunchpadHome:rocket2dmn <<DateTime(2008-09-23T18:07:50-0700)>>

• Thanks! I didn't want to step on any toes. (: -- littlergirl <<DateTime(2008-09-24T08:52:47+0000)>>

links to the parent page

<<FullSearchCached(DocumentationTemplate)>>

---