Last modified on 12 April 2012, at 22:16

The World of Peer-to-Peer (P2P)/Conventions

Adopted RulesEdit

If not stated otherwise here as a general rule, all guidelines from Wikibooks:Manual_of_Style are in effect.

Page naming and structure Yes check.svgEdit

We are using the slash convention with a flat page structure as described in Wikibooks:Naming_policy

One book with many faces Yes check.svgEdit

There are two indexed: A chapter-by-chapter version and a all-in-one page version (via transclusion). New pages should be added to both.

Size of pages Yes check.svgEdit

A chapter indexed from the main page should be on one Page. However, no single page should be larger than about 30k. Larger pages should be split up.

Use specialized topics Yes check.svgEdit

By adding contributions, try to help us give some structure to the book, do so by creating as much different and separate chapters/sections and sub-sections possible using unique (if doable) specialized topics so to give the reader the most complete and logic understanding of the language, your are also encouraged to add empty ones, so future contributors my add to them.

Authors section Yes check.svgEdit

Every person making non-trivial changes to this book may add themselves to the Authors section. This can be done by adding your name/alias and including a link to one of your wikimedia page, web-page or an active email address where you can be reached.

Proposed: 19 Sept 2005 Voted: 21 September 2005 Moved to adopted by: --Panic 04:24, 17 January 2006 (UTC)

Level 1 Heading Nummeration Yes check.svgEdit

We are using level 1 headers (=header=) for the parts. To allow transclusion, main submodules should always start with and have at most 1 level 2 header (==header==).

Proposed: 20 Sept 2005 Not Contested, Moved to adopted by: --Panic 04:24, 17 January 2006 (UTC)

Source code style Yes check.svgEdit

To allow adoption from other sources, there is no mandatory brace / indentation style throughout the book for code examples. However, please be consistent within one example.

There is a non adoption of a single standard on styles (ie: brace style) so to make the work of importing any other snips of code easier, it also shows readers all the options they can make, so you can use the style you prefer and modify any existing code on the book, but authors are not expected to follow a particular style.

Common Programming Errors Yes check.svgEdit

Common programming errors should pointed out throughout the book.

Proposed: 18 Sept 2005 Not Contested, Moved to adopted by: --Panic 04:24, 17 January 2006 (UTC)

NOTE Boxes Yes check.svgEdit

Note:
Use of template for Notes as notification of extra/non standard/common practice notices to the reader.

{{NOTE|Use of template for Notes as notification of extra/non standard/common practice notices to the reader.}}

Proposed: 27 Nov 2004 Not Contested, Moved to adopted by: --Panic 04:24, 17 January 2006 (UTC)

TODO Boxes Yes check.svgEdit

Clipboard

To do:
There should be TODO boxes in the text, telling the reader that there is something to be written here.

{{TODO|There should be TODO boxes in the text, telling the reader that there is something to be written here. }}

Proposed: 18 Sept 2005 Not Contested, Moved to adopted by: --Panic 04:24, 17 January 2006 (UTC)

Proposed Issues have a lifetime of 7 days Yes check.svgEdit

If a proposed issue is not contested, debated or altered in 7 days it should be moved out of the Proposed section as adopted.

Proposed: --Panic 05:02, 17 January 2006 (UTC) Not Contested, Moved to adopted by: --Panic 03:48, 4 March 2006 (UTC)

Print Version Yes check.svgEdit

The book will only have a single print version, that may include by chapter subsections

Proposed: --Panic 00:27, 10 April 2008 (UTC) Not Contested, Moved to adopted by: --Panic (talk) 05:30, 1 August 2008 (UTC)

Title/Cover page Yes check.svgEdit

Cover page will display the historical book index and any significative change (>51%) to the cover page will be have to be the object of previous discussion resulting in acceptance without objections

Proposed: --Panic 00:27, 10 April 2008 (UTC) Not Contested, Moved to adopted by: --Panic (talk) 05:30, 1 August 2008 (UTC)

Language Yes check.svgEdit

United States English should be used whenever possible

Proposed: --Panic 03:20, 15 April 2008 (UTC) Not Contested, Moved to adopted by: --Panic (talk) 05:30, 1 August 2008 (UTC)