ვიკიწიგნები:სტილის სახელმძღვანელო

ვიკიწიგნებიდან
Jump to navigation Jump to search

The Wikibooks Manual of Style is intended to describe the ideal construction of textbooks on Wikibooks in order to establish consistency between books and thus to improve usability of Wikibooks as a whole.

Titling[რედაქტირება]

Wikibooks aims for a certain method of titling module pages, depending on the aspect of the book. The aspect of a book can be said to be the target audience and/or aims of the book. Several books on one topic but with differing aspects can exist (see Wikibooks:Forking policy for details).

On Wikibooks aiming for a generic aspect, that is, a wide-ranging aspect, or alternatively, a book with an aspect similar to a print textbook, a generic title may be used. For example, a book on woodwork aimed at the general public may be entitled "Woodworking", or, a book aimed at woodworking students may also be entitled "Woodworking". A book on financial mathematics may be entitled "Actuarial studies".

For books aiming for a narrower aspect, for example, a mathematics text for commerce students, a more specific title can be used, so, in the previous example, "Mathematics for commerce" or "Commercial mathematics" may be used.

Some people feel that the casing for the titles should match that of Wikipedia's scheme for titles, viz., the first letter of the title and all proper nouns should be capitalized, and no other letters should be capitalized. Others prefer the use of titlecase for titles; all words are capitalized except for minor words (articles and conjunctions mainly) not appearing at the beginning. Please follow the existing style for the book you are editing.

See Wikibooks:Naming policy for more information on how to and how not to name books and their chapters.

Structure[რედაქტირება]

Books should follow the following structure.

In accordance with the titling specification, a contents page should be created in the main namespace using the book title. A page should be created with a short introduction (a longer introduction can always be placed elsewhere, see below), a header "== Contents ==", followed by a bulleted list of divisions of the book as a whole. Additional bulleting/indenting can be used to introduce structure. Alternative structuring may also be used.

The way structure is reflected in the module names has been decided, and the results of that decision can be found at Wikibooks:Naming policy.

Title Pages[რედაქტირება]

As each book has a front cover, so to, does a Wikibook have a title page. You can create a title page separate from table of contents for your book to provide a short description of the scope of your book.

A book's title page should describe the purpose of the book, and thus, there should be a short paragraph explaining what the book is trying to teach, and the topics that it may cover. In short, the title page should summarize the entire book to the best of your ability. You can also use a cover image for decorative purposes.

If the title page isn't the first page a reader sees and your book is named Book, as per naming conventions, the title page should be named Book/About or Book/Cover.

Creation of Title Pages[რედაქტირება]

As a rule, a link to the table of contents should be placed on the title page. The title page should also link to a book's specific manual of style. There should also be a link to a list containing the names of all the users actively working on the project - it can be placed in the manual of style, in a foreword or on a separate "Authors" page. This page may also be linked to from the table of contents.

It's good to point to a central discussion page for the whole book, so that contributors have one place for discussing issues that concern the book as a whole.

If a print version or PDF version of your book is available, you can announce it using the {{ print version }} and {{ PDF version }} templates or just add a normal link to them.

Cover images should be kept to a minimum, and should not dominate your title page. Then, if your book is nominated as a featured book, the cover image is used to represent your book on the main page.

If a book is listed in categories and has interwiki links, all of them should be placed on the title page, not the table of contents.

Linking Title Pages[რედაქტირება]

If a book has a title page, its table of contents should not contain any interwiki links or categories. You should provide a link to the title page at the top of book's table of contents. This may already exist for books using the slash-convention. If you use custom navigation templates, you should not link to the title page.

External links, like links from bookshelves, should point to the book title page, not the table of contents.

The main page of your book is where the important information regarding how the book is in relation to other books, or Wikibooks in general, resides. If your book needs to be transwikied or is put up for deletion, then that information will be on the book's title page. Our category system will also only categorize title pages of the books.

Like a library, each book must be categorized. Currently, the card catalog office organizes books by their bookshelf, by their name, by Subject, by the Dewey Decimal Classification system, as well as the Library of Congress system. If you are unaware of how your book is to be categorized, please place a link to your book at the CCO's main page and other Wikibookians will help you categorize your book.

Title page and print version[რედაქტირება]

If you are preparing a print version of your book, include the title page in it.

Some things from title page should not be included in print version - like interwiki, categories and some templates (for example, {{ print version }}). Hence, you should put them inside <noinclude> ... </noinclude> tag. You are also encouraged to add some information visible only in print version (using <includeonly> ... </includeonly> tag), similar to:

თარგი:TextBox

Internal[რედაქტირება]

Module pages may require structure in the layout of content.

Linking[რედაქტირება]

Modules using a large amount of substructure should include links in each content page for navigation within the structure. A suggested method is to create a template with the requisite links, and to include this template on the necessary pages.

Headers[რედაქტირება]

Headers should be used to indicate structure in layout. Primary information should be marked with a "==", and information secondary to that should be marked with a "==="header, and so on, for example:

== Animals ==
There are many kinds of animals.

=== Cats ===
Cats are animals.

=== Dogs ===
Dogs are animals.

There is no need to provide systematised navigation between headers as the Linking section describes; only provide navigation between pages.

Content layout[რედაქტირება]

It is suggested that:

  • like Wikipedia, the first use of the title words or words that are akin in sentiment to the title words are marked in bold.
  • when a new term is introduced, the term is italicised.

Mathematics[რედაქტირება]

Use HTML/Wiki-formatting when using variables or other simple mathematical notation within a sentence, and use <math></math> tags when using "display" mathematics. If the notation is too complicated for a module where notation is used within a sentence, consider switching to using "display" style (see below).

HTML guidelines[რედაქტირება]

Italicise variables: a+b, etc. Do not italicise Greek letter variables, nor italicise function names or the brackets.

Display guidelines[რედაქტირება]

To introduce mathematics notation in a display format, move to the start of the new line, add a single colon, and then the notation within the <math></math> tags. If punctuation follows the notation, do so inside the tags.

For example,

is correctly used for "display" guidelines.

For consistency, if some notation does not render as PNG, force it so by adding a \, at the end of the formula. Ensure that the way the notation is displayed is consistent.


Footnotes and References[რედაქტირება]

Wikibooks has a really nice way to do footnotes and references. Much better than HTML, or most word processors! First put in a reference in the form:

"This hedgehog will live with us!"თარგი:Ref

(Click "edit" to see the code for this.) That makes a superscript number that your readers can click on. Then at the end of your file put in the note:

  1. თარგი:Note Chapayev, V.I., "Sesquipedalian Obfuscation in Late Early Middle Wikibooking," Journal of Very Specialized Research, 2005.

Remember the pound sign (#) to make the matching number appear.