- From: Jonathan Garbee <jonathan@garbee.me>
- Date: Mon, 05 Nov 2012 17:13:38 -0500
- To: public-webplatform@w3.org
- Message-ID: <50983A12.9030603@garbee.me>
Perfect for now. Eventually I would like to have a page that completely documents the compatibility tables, but for now that section does exactly what we need. Thanks for the addition. -Garbee On 11/5/2012 3:57 PM, Alex Komoroske wrote: > I took a rough first stab at documenting it on that page. > > On Mon, Nov 5, 2012 at 10:18 AM, Jonathan Garbee <jonathan@garbee.me > <mailto:jonathan@garbee.me>> wrote: > > We should document in the Editor's Guide [1]. It is currently > super-early and very bare in info (most actually imported from the > Getting Started Guide.) I saw you were working on some more > editors docs, which I would love to talk about getting rolled into > this guide. In a day or two I'm opening a bug report on the guide > with a list of things I think we should have in it and how I'm > thinking we should structure it. For now though, just dropping a > new section in is fine to get it down. > > -Garbee > > [1] http://docs.webplatform.org/wiki/WPD:Editors_Guide > > > On 11/5/2012 12:41 PM, Alex Komoroske wrote: >> >> >> On Sat, Nov 3, 2012 at 5:11 PM, <jonathan@garbee.me >> <mailto:jonathan@garbee.me>> wrote: >> >> Awesome, thanks Alex. I think we need to say what the >> centralized place to pull tables from is, say for HTML >> Elements it is their appropriate element page. That way >> there is one central place to do updates which will then be >> referred to on the rest of the pages. That way we don't have >> a web of reference tables being made. >> >> >> Agreed that this is very important. The best practice is that the >> "real" compatibility table is included on the most-specific >> reference page that relates to this method/property/API. It >> should then be imported from there to any other page that wants >> to show it. >> >> Where do you think we should document this? >> >> -Garbee >> >> On 03.11.2012 08:04pm, Alex Komoroske wrote: >> >>> I just implemented this at the hackathon. >>> It is now possible to add "Imported compatibility tables" to >>> pages. You just specify the page you want to lift the >>> compatibility table from, and a reference to it is >>> automatically included in the page. You can choose to import >>> multiple compatibility tables. >>> *This is now the preferred way of handling compatibility on >>> tutorial/guide/concept/etc articles*. The canonical >>> compatibility information should exist on the specific >>> reference articles, and then be included via this mechanism >>> into related tutorial pages. >>> The usability around this in the form is TERRIBLE right now; >>> it's very unclear what the difference is between imported >>> and non-imported compat tables, and when you should use >>> either. If anyone has any ideas on how the editing >>> experience should be I can implement it in the form >>> definition[1]. >>> --Alex >>> [1] >>> http://docs.webplatform.org/wiki/Template:Compatibility_Form_Section >>> >>> On Fri, Oct 19, 2012 at 4:00 PM, Janet Swisher >>> <jswisher@mozilla.com <mailto:jswisher@mozilla.com>> wrote: >>> >>> This would be really helpful for translation, so that >>> the table is maintained only once. >>> >>> >>> On 10/19/12 4:52 PM, Alex Komoroske wrote: >>>> In an ideal world I think we'd have some way of >>>> grabbing a compatibility table from one article and >>>> transcluding it in another. That would allow us to have >>>> the canonical data on the specific reference page for >>>> each feature and then just dynamically include it on >>>> other articles where it's relevant (like on articles). >>>> This should theoretically be possible with semantic >>>> media wiki queries and properties. >>>> >>>> On Fri, Oct 19, 2012 at 2:40 PM, <jonathan@garbee.me >>>> <mailto:jonathan@garbee.me>> wrote: >>>> >>>> Do we want the compatibility tables [1] to be >>>> anywhere or do we want them to be centralized in an >>>> area (such as the elements page)? >>>> >>>> I think we should centralize them in order to >>>> create less maintenance later on. If we have >>>> tables in any page for elements listed then it >>>> isn't going to be easy later on to update them if >>>> needed and could cause confusion on where to get >>>> the information. I am thinking we should >>>> centralize them under the element itself [2] to >>>> solve these possible issues. >>>> >>>> [1] example table: >>>> http://docs.webplatform.org/wiki/guides/html_text#Compatibility >>>> >>>> >>>> [2] example element: >>>> http://docs.webplatform.org/wiki/html/elements/em >>>> >>>> Thoughts? >>>> >>>> -Garbee >>>> >>> >>> >>> -- >>> Janet Swisher <mailto:jREMOVEswisher@mozilla.com> >>> Mozilla Developer Network <https://developer.mozilla.org> >>> Technical Writer/Community Steward >>> >> > >
Received on Monday, 5 November 2012 22:14:12 UTC