["FrontPage"] > ["DebianWiki"] > Conventions discussion

Translation(s): none


Table of Contents?TableOfContents(3)

Please sign your comments using @SIG@.

Current Discussions

Translation

-- SalokineTerata ?DateTime(2007-11-10T13:54:59Z)

debian-l10n-french@lists.debian.org. Felipe Augusto van de Wiel and RaphaelHertzog propose the current rules. (see old discussion below)

-- -- FranklinPiat ?DateTime(2007-11-10T14:26:40Z)

Official stuff

Why not ?

inline:Portal/IDB/logo-gohome-32x32.png

http://... - Homepage

Old Discussions

?Anchor(discussionspages)

URL for Discussion page convention

Same as above: there is a lack of consistency. Some discussion pages like this one are named using the camel case (?DebianWikiConventionsDiscussion). Other pages use a slash (.../Discussion), like ["FrontPage/Discussion"]. Which standard to use? -- AugustinMa ?DateTime(2007-10-08T10:01:05Z)

Something lile [:/Discussion:Discussion] is easy to use with templates or when you copy and paste contents. Relative path are more flexible. I recommend to integrate this link in the default banner to invite readers for discussion.

1. Since it's very sensitive to edit a user's comment(s) in a Discussion (["ReFactor"]), we don't want to have lots of unneeded ones. 2.We don't want to turn wiki.d.o into a mailing list ;) 3. Including Discussion at the top right of the page requires to use table for the header, which make it complex (less easy to read). -- FranklinPiat ?DateTime(2007-10-14T23:49:02Z)

Policy suggestion #1

-- SalokineTerata ?DateTime(2007-10-11T21:08:49Z)

 (!) [:/Discussion:Discussion]

Policy suggestion #2

proposition #2 withdrawn. see Policy 3

Policy suggestion #3

 (!) [:/Discussion:Discussion]

?Anchor(banner)

Articles don't have real imposition in their forms. Just some informations are strongly recommended.

I don't really like ".." because i dont't where i would end up if i click it. I assume that if the lines because too long, it's because the path from the top is too long. -- FranklinPiat ?DateTime(2007-10-10T23:53:24Z)

Supplementary recommendations about portals

Portal ["Portal_Introduction"] play a part of template. Use it to create a new portal easily.

Besides preceding recommendations, portal pages must be named like:Portal + _ + Title of portal.

They must contain:

Supplementary recommendations about articles

Policy suggestion #1

-- SalokineTerata ?DateTime(2007-10-11T21:08:49Z)

Policy suggestion #1

-- SalokineTerata ?DateTime(2007-10-11T21:44:25Z)

Warning

If you find redundant articles, please, insert this flag at the top of the page:

Redundant : This article contain redundant information.?BR Please, merge it with ["Name_of_the_other_article"].

I Think it isn't important for the visitor, when he/she starts reading the page, to known that the page duplicates the content of another one. So we don't need to put a big colored warning : We could put a simple link at the bottom of the page, so if a user actually don't find the answer, he/she can carry-on on another page. -- FranklinPiat ?DateTime(2007-10-10T23:53:24Z)

{{{||<tablestyle="width:65%;margin-left:35%;padding-left:30pt" style="border:1pt solid #b48;border-left:5pt solid #d4a">Redundant : This article contain redundant information.?BR Please, merge it with ["Name_of_the_other_article"].|| }}}

If you find an article without enough information, please, insert this flag at the top of the page:

Not enough content : This article have not enough content.?BR Please, improve it or merge it in an article having the same goal.

{{{||<tablestyle="width:65%;margin-left:35%;padding-left:30pt" style="border:1pt solid #b48;border-left:5pt solid #d4a">Not enough content : This article have not enough content.?BR Please, improve it or merge it in an article having the same goal.|| }}}

Portals are good tools to identify redundant articles. If you find its, finish link with this simley X-( X-(

-- SalokineTerata ?DateTime(2007-10-10T21:57:29Z)

OBSOLETE

This page is obsolete. see ["InstallationHOWTO"] ; ?InstallationHelp ; ?InstallDebian ; MiscInstallTips

-- SalokineTerata ?DateTime(2007-10-12T22:49:03Z)

Policy suggestion #1

-- SalokineTerata ?DateTime(2007-10-15T21:23:02Z) (restart 10 days remaining)

Wiki Policy Approbation

-- SalokineTerata ?DateTime(2007-10-14T21:43:07Z)

Management understanding reader level

?Anchor(portal-reader-level)

The Portal Welcome is composed in 4 global parts. Each part aggregate other portals by knowledge level. Language using in article must be adapt to reader level. You can differentiate knowledge level like this:

?Anchor(pages-names)

URL / page naming convention

We should come up with a semi-official convention for page naming. Apparently there are a handful of contributors who have a long term view of what the wiki should look like, but each seems to be working in his/her corner. The result is kind of a mess.

Some page are named using the camel case, like this one (?DebianWikiConventionsDiscussion). Others use an underscore like all the links in this page: ["Portal_Welcome"]. Some page are only a single word, like ["About"].

We should come up with a convention. What is the advantage of using one rather than the other? -- AugustinMa ?DateTime(2007-10-08T10:01:05Z)

  • I think comprehensible page naming is very important. Readers appreciate clear name. So I prefer break up sentences and contract them. I recommended to get a user-friendly apporach. It's necessary to have short name, not a big sentence. Underscore must be used than white space. White spaces are not recommended in the URL.?BR

  • Example of Page naming for "How to configure ATI driver to active 3D support":

    • Example #1: HowToATI3D

    • Exemple #2 (I think more comprehensive): ["Howto_ATI_3D"]

    • Counter-example: ["How to configure ATI driver to active 3D support"]

    • For link, I recommend some thing like: [:Howto_ATI_3D:How to configure ATI driver to active 3D support]?BR

    -- SalokineTerata ?DateTime(2007-10-10T21:57:29Z)

    Regarding page naming, we have to take in consideration that we use moinmoin. We shouldn't use columns (:) because this would break [:page:name: title]. Like many user who have used mediawiki, i used to prefer space or underscores in page name. however, it isn't how moinmoin expect to work, so I switch to the wiki.debian.org de-facto standard i.e use WikiName. -- FranklinPiat ?DateTime(2007-10-10T23:53:24Z)

-- SalokineTerata ?DateTime(2007-10-15T21:23:02Z)

  • {{{ avoid "@=$*

}}}

Use of CamelCase

This wiki is based on MoinMoin, which makes it easy to use CamelCase to create links and new pages. However, the page ["Portal_Welcome/Discussion"] suggests we use words separated by underscores (like_this instead of ?LikeThis). I don't particularly like ?CamelCasedTitles but it is easier to use them and people will use them regardless of what we decide. This is an important decision to make before we go too far in organizing the wiki. Your comments are welcome here. -- AugustinMa ?DateTime(2007-10-09T04:47:10Z)

As you, I don't like particulary CamelCasedTitled. I prefer naming conventions [http://en.wikipedia.org/wiki/Help:Page_name like Wikipedia]. -- SalokineTerata ?DateTime(2007-10-10T21:57:29Z)

Currently, out of 5000 pages, 200 pages contains an underscore, 3800 are ?CamelCased. In order to remain consistent, we probably want to stick to moinmoin's (ugly) convention.

-- FranklinPiat ?DateTime(2007-10-14T23:49:02Z)

Felipe Augusto van de Wiel (faw) - Monday 22 October 2007 05:59:55

Policy suggestion #1

-- SalokineTerata ?DateTime(2007-10-11T21:08:49Z)

  • Concise title
  • Can using underscore "_" to separte words
  • Can using CamelCase

  • Each word start with uppercase
  • Don't use these characters:columns  : , semicolon  ; , space  " " , backslash  \ , accents  é à ö ñ ..., apostrophe  ' 

  • Using slash can be use to group same pages
  • Translated pages finished with the name of Language (place side by side)

Policy suggestion #2

-- very similar -- FranklinPiat ?DateTime(2007-10-14T23:49:02Z)

  • Should using CamelCase

  • Can use underscore "_" to separate words (not recommended).
  • First letter of first word should be upper. (["debconf"] + ["DebConf"])

  • Special characters shoud be avoided in page names. Using underscores is ok.
  • Using slash should be use to group same pages
  • Translated pages finished with the name of Language

Policy suggestion #3

#Merge the Felipe Augusto van de Wiel's comments

  • -- SalokineTerata ?DateTime(2007-10-23T21:24:17Z)

  • Use only CamelCase

  • First letter of first word should be upper. (["debconf"] + ["DebConf"])

  • Special characters shoud be avoided in page names.
  • Using slash should be use to group same pages
  • Translated pages finished with the name of Language

URL / Portals naming

?Anchor(portals-names)

-- SalokineTerata ?DateTime(2007-10-15T21:23:02Z)

-- SalokineTerata ?DateTime(2007-10-16T21:27:49Z)

Felipe Augusto van de Wiel (faw) - Monday 22 October 2007 05:59:55

Policy suggestion #1

-- SalokineTerata ?DateTime(2007-10-11T21:08:49Z)

Policy suggestion #2

  • Using separated words with underscore or CamelCase... (conform with regular page naming policy, yet to be choosen).

  • Translated portal page name conform with regular page name policy (Portal_Hardware / Portail_HardwareFrench 

Policy suggestion #3

-- SalokineTerata ?DateTime(2007-10-16T21:17:28Z)

  • Using separated words with underscore or CamelCase... (conform with regular page naming policy, yet to be choosen).

  • Portal's page name needn't (shouldn't?) be prefixed the word "Portal".
  • Translated portal page name conform with regular page name policy (HardwareSupport / HardwareSupportFrench )

Policy suggestion #4

#Merge with Felipe Augusto van de Wiel's comments -- SalokineTerata ?DateTime(2007-10-23T21:24:17Z)

  • Using only CamelCase (conform with regular page naming policy, yet to be choosen).

  • Portal's page name is prefixed the word "Portal".
  • Translated portal page name conform with regular page name policy (HardwareSupport / HardwareSupportFrench )

Policy suggestion #5

  • Portal naming is identical like article naming convention

?Anchor(portal-content)

Help to update content

-- SalokineTerata ?DateTime(2007-10-21T00:26:56Z)

  • To begin to identify future contents of portals, I propose to use categories. We flag pages with the category of its future attached portal. Next, when we will create and format portals, it will be easy to get content. For user that don't have the time to attach their pages, they can use this method. Next we can get pages and update portals nicely.

    Each portals could be have a section called "Pages want to be attach" or "TODO: page in coming" with an [[Include(CategoryOfPortal)]]?

Map

?Anchor(portal-structure)

-- SalokineTerata ?DateTime(2007-10-15T21:23:02Z)

IMHO, I am quite happy with the categories on the FrontPage (using debian + developping debian + news). A Debian Quick-Start section would be on my wishlist (Beginner might be misleading).

-- SalokineTerata ?DateTime(2007-10-16T22:07:53Z)

Felipe Augusto van de Wiel - Monday 22 October 2007 05:59:55

-- SalokineTerata ?DateTime(2007-10-23T21:24:17Z)

Policy suggestion #1

-- SalokineTerata ?DateTime(2007-10-19T22:32:13Z)

  • I try to propose portal map, don't hesitate to modify it:

  • News
  • Quick-Start
    • Quick-Presentation
    • Quick-Install
    • Quick-Managing your system
  • Users
    • Desktop
      • GNOME
      • KDE
      • XFCE
      • ...etc
    • Software
      • Office applications
      • Configuration Tools
      • Developpement and language programming tools
      • Edutainment
      • Emulators
      • Graphics
      • Internet and networks
      • Games
      • Multimedia
      • Security
      • ...etc
    • Hardware
      • Gamepad
      • PDA
      • Videocards (GPU)
      • Webcams
      • Wifi
      • Computer
      • Laptop
      • ...etc
  • Administrators
    • Shell and command line: concept, scripting, bash ...
    • Manage a your Debian system
      • Linux: Kernel compilation, customization and configuration
      • Initialisation process and booting system stages
      • APT: advanced notions
      • User and acces rights
      • X System Windows
      • Sound subsystem: OSS, ALSA ...
      • Printing: CUPS, LPR...
      • Backup
      • ...etc
    • Manage your server
      • RAID
      • Heartbeat/DrBD
      • Clustering
      • Virtualisation
      • Monitoring
      • LTSP
      • ?ThinClient

      • Domain Service: Manage your client
      • ...etc
    • Network services and protocols
      • Protocols: TCP/IP, IPX, ATP ...
      • SMB/CIFS
      • SSH
      • LDAP
      • DNS
      • ODBC
      • DHCP
      • Mail servers: postfix, sendmail ...
      • Web servers: Apache ...
      • Databases: MySQL, PostgreSQL ...
      • Openvpn and tunneling
      • Remote desktop: VNC, XDMCP, RDP ...
      • ...etc
  • Developers
    • Debian Developers
      • How to help Debian Project: Teams, alioth, official documentation...
      • Packages: Reportbug and debugging, create package ...
      • Distributions: Live, Custom, Friends of Debian, Other distributions...
    • Programming Language: C/C++, PHP, Pearl, Java, Python ...
    • Programming tools: IDE, CVS, subversion ...
    • Traductions
  • Wiki
    • Quick-Start Editor
    • Editor Guide
    • Wiki administration
    • Moinmoin

Knowledge level indicator of article

?Anchor(level) All articles attached to a portal must indicate its knowledge level at its top. Normally, You have just to take the same level of attached portal. This indicator is symbolized by star items:

Ready to paste:

 {o} {o} {o} ''Beginner''
 {*} {o} {o} ''User''
 {*} {*} {o} ''Advanced user''
 {*} {*} {*} ''Developer/Contributor''

As suggesting Franklin, articles can't be always classified in this point of view. To go in his way, I recommend to use these indicators only for Portals pages.

Each parts of portals must be guide the readers. By example, Portal_Shells is classified Advanced user, but at first, this portal must explain what is a shell and the basic howto. Next, real howto can be presented. Other example, Portal_Developer (classified Developer/Contributor) must present official references, debian.mentors, your first package howto ...etc and all of what you want when you would like to become a new developer.

Maybe we can rename this four levels as Beginner, User, Administrator and Developer ? -- SalokineTerata ?DateTime(2007-10-10T21:57:29Z)

Franklin

Felipe Augusto van de Wiel - Monday 22 October 2007 05:59:55

?Anchor(links)

A portal contain only links ... and just that. It's like a switching system. Links must be written and translated without to show wiki syntax.

  • Example: [:ThisIsCorrectLink:This is a good link for an example]

  • Counterexample: ?ThisIsCorrectLink - This is not a good presentation of this link.

If your link point to article written in other language that your native language, indicate it at the end of the link.

alternative :

An helpful description, understandable and concise.

-- SalokineTerata ?DateTime(2007-10-15T21:23:02Z)

Policy suggestion #1

-- SalokineTerata ?DateTime(2007-10-11T21:08:49Z)

  • Links are composed like: [:TitlePage:Understandable and concise description]

  • Not native language links finish with destination language: ''(in french)'' or ''(en anglais)''

Policy suggestion #2

Proposal withdrawn (#1 and #2 are now merged in #3)

Policy suggestion #3

-- SalokineTerata ?DateTime(2007-10-25T20:47:28Z)

Is it the official portal of Wiki Debian ?

Yes and No !

This set of page comes from user's initiative as you. Portals can be considered as official because there are on Debian Wiki. On other hand, the official page assembled information of the Wiki is the ["FrontPage"]. In brief, it's not the most important question. The real question is: Is this portal answer to my needs ? If you reply No ... you can contribute to improve it. If you reply Yes, speak well of it.

Portal concept must be more stable, more hold and more translated. Next, maybe we can update the frontpages ?

Policy suggestion #1

-- SalokineTerata ?DateTime(2007-10-11T21:08:49Z)

  • "Portal_Welcome" will be renamed "?FrontPage/PortalProposal". It's more understandable

  • To prepare the update of frontpage, all pathes in banner don't must integrate "Portal_Welcome" but "FrontPage" pages as root page

  • When Portals will be stabilized, we come back here to validate the beginning of the frontpage update

?Anchor(editor-guide)

Debian Wiki /Editor Guide

Could you have a look at ["DebianWiki/EditorGuide"] : Contributions (there) & Feedback (here) are welcome.

Thanks, -- FranklinPiat ?DateTime(2007-10-10T23:58:26Z)

Very good job ! -- SalokineTerata ?DateTime(2007-10-11T21:44:25Z)

-- SalokineTerata ?DateTime(2007-10-25T20:49:22Z)

  • Could we define ["DebianWiki/EditorGuide"] as the referent page about Debian Wiki Policy ? In this case, can we write this at this top of its page ?

?Anchor(translations)

Pages Translations

  • PaoloPan had started a discussion thread about translations on [:?WikiMeta#translation:WikiMeta] a while ago. Shouldn't we have that discussion about translation on that page ?

  • I have written the ["DebianWiki/Translation"], based on the current practices i have observed on this wiki. (I haven't included Salokine's proposal... since it's a proposal. The page will have to be updated once there's a standing position.).
  • FYI, we might want to ask for advices about translations to some experienced people :

-- FranklinPiat ?DateTime(2007-10-11T23:52:57Z)

Another problem are translated pages, there's no convention used (check the FrontPage translations for an example). There's been talk about the lack of proper i18n support in MoinMoin, like the checks for outdated translations that the current Debian website is doing.GuillemJover

Felipe Augusto van de Wiel - Monday 22 October 2007 05:59:55

-- SalokineTerata ?DateTime(2007-10-24T18:42:15Z)

Felipe Augusto van de Wiel

-- SalokineTerata ?DateTime(2007-10-24T18:42:15Z)

Felipe Augusto van de Wiel

RaphaelHertzog Wednesday 24 October 2007 21:11:12

Policy suggestion #1

-- SalokineTerata ?DateTime(2007-10-25T20:10:08Z)