Skip to content

Discussion_on_content_and_structure_of_Cocorico!

Pierre Letouzey edited this page Oct 23, 2017 · 15 revisions

This page is for discussing Cocorico's contents and structure.

General style

English sentences vs internal WikiName to refer to internal pages

Cocorico uses the actual WikiName of an internal page to talk about it. I think that we would get more fluent texts if one'd use ordinary English sentences to mention an internal link. Compare for instance a mention to the Cocorico's front page and another mention to the same CocoricoFrontPage. [HH]

English sentences vs internal WikiName in titles

An extension to MoinMoin allows to use ordinary English sentences for page titles. I believe it would offer the possiblity of more flexible and smoother-to-read page titles. [HH]

The above patch is applied. -- MiladNiqui DateTime(2007-10-26T09:20:45Z)_

An alternative solution is to directly use English sentences between quotes for wiki page names. This works well for new pages. For already existing pages in the WikiName format, it would however require the renaming of all existing links to a so-renamed page. [HH]

External links

Should the exact URL of external links be made explicit in Cocorico pages (as it is the case for instance in the Tools page)? General web practice is to bind URL to regular English expressions rather than binding it the text of the URL. If one really wants to know an URL, it generally appears anyway at the bottom of the browser when the mouse is over the link. [HH]

Use of table of contents

My feeling is that table of contents are relevant on pages with proper elaborated contents. I don't think that they are necessary for pages that consists in a list of links. For instance, removing the table of contents from the Cocorico's front page would remove what at the end is just a redundant information. [HH]

Yes, on the front page it was redundant (removed now). -- MiladNiqui

Reference to individuals

If one looks at the pages of wanted pages, one sees several pages named after a individual. Wouldn't it be better to link to the existing (external) page of the persons cited rather than creating new stub pages for these individuals? [HH]

Yes it is a good idea. But the stub pages are also created for users of this wiki when they edit a page (because their username will appear on the RecentChanges page). In that case it might be good to put at least a link to the external page of the individual on the stub page. -- MiladNiqui

Organisation of the contents

My opinion is that Cocorico has now grown enough to justify a step of reorganisation of the contents. I don't have a clear global idea of what to do but a few restructuration steps are certainly worth to be done.

Among other things, I'm thinking about grouping similar topics under a same heading (grouping for instance the contact links nable and irc; the documentation links general documentation, the logical theory of Coq, extending the source of Coq and documentation on modules).

I also wonder whether the front page could start with a short text, linking among others to the page (from the CoqNewbie page) that compares Coq to other similar systems. [HH]

Here is a new proposition for formatting the Coq topic available on the Front page.

The Coq Community Documentation Formalisations Software
The newbie zone Books and Manuals Standard Library Interfaces
Coq-club on Nabble Tutorials Formalized in Coq... Software Verification
irc channel Frequently asked questions Coq pearls Tactic plugins
Coq in the classroom Logical foundations Tactic pearls Documentation tools
Misc. documentation Project ideas
About Coq code source Coq's style
About This Wiki

Notes: About Coq source code would link to a new page that includes CoqCustomizationHowTo_ and TheSource; the page on modules would be in the (new) Misc. documentation page; the UserContribution page would be integrated to the FormalizedAndVerified_ page. The TipsAndTricks page would be integrated to the FrequentlyAskedQuestions_.

Most of these are applied now. What should Tutorials point to? Right now it points to CoqNewbie. -- MiladNiqui DateTime(2007-12-03T15:41:24Z)_

Clone this wiki locally