W3C home > Mailing lists > Public > public-dwbp-wg@w3.org > November 2014

Re: BP Doc skeleton on GitHub

From: Bernadette Farias Lóscio <bfl@cin.ufpe.br>
Date: Mon, 10 Nov 2014 18:40:50 -0300
Message-ID: <CANx1PzzFPfQtBUC=BYw25hFxcrDOjJ+H7eZw5iQBVb=VjmKp6g@mail.gmail.com>
To: Phil Archer <phila@w3.org>
Cc: Public DWBP WG <public-dwbp-wg@w3.org>, Yaso Córdova <yaso@nic.br>
Hi Phil,

Thank you very much for creating this skeleton for our BP document!

As soon as we have more content, we're gonna improve this version.

kind regards,
Bernadette

2014-11-07 7:36 GMT-03:00 Phil Archer <phila@w3.org>:

> Dear all,
>
> I think we achieved a great deal last week at TPAC. There is a long way to
> go but I feel that we're now properly on the road with much improved
> navigation to help us get there.
>
> One of the things we talked through was the proposed structure of the BP
> doc [1] that Bernadette worked on with Yaso, Newton and Caroline (I
> think?). We also talked about what a best practice might look like [2] and
> learned about the XML Signature Best Practices document [3] that used
> ReSpec's functionality to keep track of BPs.
>
> Taking all that in to account I wanted to see what that would mean for our
> own BP doc and so I have created a skeleton [4] (also linked from the wiki
> main page). Some points to note:
>
> 1. This is just a bunch of place holders and nonsense. There is no text
> here that is intended to survive even the first edit! (actually, I did
> include the 3 axioms that we resolved but that's all).
>
> 2. I put the ReSpec config in a separate  file.
>
> 3. I've used ReSpec's Best Practice functions and inserted 3 dummy best
> practices. I've added a little bit of styling but not much. The way styling
> works is that editors are free to insert whatever styles they like but the
> last set of styles is defined by the external W3C stylesheet and we're not
> allowed to overrule that (no inline styles).
>
> The BP summary section is auto-generated. I added a bit of styling to make
> the list appear in 1, 2 or 3 columns depending on the width of your screen
> (and I only used the generic column-count style, not the proprietary ones
> so, for now, you only see the columns in Opera and IE. Chrome and Firefox
> will show a single column, irrespective of screen width).
>
> 4. I've currently just put Bernadette as editor and there's a place holder
> then for authors, i.e. those who, over time, make significant
> contributions. Editors and authors can all be changed of course.
>
> @Yaso - in my battles with GitHub I ended up deleting the usecasesv1.html
> file. I've added in a copy of the current published draft (as
> usecases.html) and editors will need to re-insert the ReSpec links to work
> with this but that's less of a task than it was to generate the published
> version from the ReSpec version I promise. I had a conflict that I couldn't
> resolve so in the end git rm usecasesv1.html was the easiest option.
>
> HTH
>
> Phil.
>
> [1] https://www.w3.org/2013/dwbp/wiki/Proposed_structure#Table_
> of_Contents_DWBP
> [2] http://w3c.github.io/dwbp/bptemplate.html
> [3] http://www.w3.org/2008/xmlsec/Drafts/best-practices/
> [4] http://w3c.github.io/dwbp/bp.html
>
> --
>
>
> Phil Archer
> W3C Data Activity Lead
> http://www.w3.org/2013/data/
>
> http://philarcher.org
> +44 (0)7887 767755
> @philarcher1
>



-- 
Bernadette Farias Lóscio
Centro de Informática
Universidade Federal de Pernambuco - UFPE, Brazil
----------------------------------------------------------------------------
Received on Monday, 10 November 2014 21:41:38 UTC

This archive was generated by hypermail 2.3.1 : Tuesday, 6 January 2015 20:24:18 UTC