16,374
edits
How to Edit Halachipedia: Difference between revisions
From Halachipedia
no edit summary
No edit summary |
No edit summary |
||
| (38 intermediate revisions by 3 users not shown) | |||
| Line 1: | Line 1: | ||
==How to Edit== | |||
===Step 1: Become a user=== | |||
==Step 1: Become a user== | |||
{| | {| | ||
|- | |- | ||
| {{#ev:youtube|kl6cQvQBbbI?rel=0}} || | | {{#ev:youtube|kl6cQvQBbbI?rel=0}} || | ||
# Create an account by [[Special:UserLogin|clicking here]]. | # Create an account by [[Special:UserLogin|clicking here]]. | ||
# Please note, that in order to prevent bots, we have set up a system that allows anyone to create an account, however the account's first edits will not be shown on the default view of the page until the account is approved, which is usually done right after the first edit is made. Once the account is approved, all future edits are shown on the default page automatically. Even after a person has an approved account, his edits are still viewed by others to see if they could be improved, but by default they do appear on the finished page. | # '''Please note, that in order to prevent bots, we have set up a system that allows anyone to create an account, however the account's first edits will not be shown on the default view of the page until the account is approved, which is usually done right after the first edit is made.''' Once the account is approved, all future edits are shown on the default page automatically. Even after a person has an approved account, his edits are still viewed by others to see if they could be improved, but by default they do appear on the finished page. | ||
|} | |} | ||
==Step 2: Learn how to edit== | ===Step 2: Learn how to edit=== | ||
{| | {| | ||
|- | |- | ||
| [[Image:EditorToolbar.png| | | [[Image:EditorToolbar.png|500px]] | ||
# You could pick up wiki code on the go by seeing the code used for pages that are already written. | # You could pick up wiki code on the go by seeing the code used for pages that are already written. | ||
# Also, you should use the editor toolbar buttons on top of the editor panel which make it a breeze to add bold, italics, references, tables, perform search and replace, and more. | # Also, you should use the editor toolbar buttons on top of the editor panel which make it a breeze to add bold, italics, references, tables, perform search and replace, and more. | ||
# Alternatively, you could read our brief help guide below before adding content. | # Alternatively, you could read our brief [[#How_to_Add_Content| help guide below]] before adding content. | ||
|| | || | ||
{{#ev:youtube|pK9cu6VFYsU?rel=0}} | {{#ev:youtube|pK9cu6VFYsU?rel=0}} | ||
|} | |} | ||
==How YOU Can Make A Big Difference In Only 10 Minutes== | |||
# The most useful job that anyone can do is organize pages. '''Please''' try this for 10 minutes, no more, and I'm sure it'll make a big difference (Be'ezrat Hashem). Yashar Koach! | |||
# Here's an outline for how to use those 10 minutes most effectively: | |||
## If you don't already have one, make a user account [[#Step_1:_Become_a_user]] (30 sec) | |||
## If you don't already know, learn the basics of how to edit a page: [[#Step_2:_Learn_how_to_edit]] (2 min) | |||
## Pick a page to work on: [[Special:WhatLinksHere/Template:Okay]] (30 sec) | |||
## Read the page (3 min) | |||
## Think about the logical order of the topic and reorder the sections (1 min) | |||
## Create sections that are missing (and leave them blank) (1 min) | |||
## Mark the page's status (see [[#Page Classification]]) (1 min) | |||
## Categorize the page (see [[#How To Categorize A Page]]). (1 min) | |||
== How to Create a New Page == | == How to Create a New Page == | ||
{| | |||
| Enter the name to create a new page: | |||
| <inputbox> | |||
type=create | |||
break=no | |||
</inputbox> | |||
|} | |||
# Unlike most websites whereby you create a new page and subsequently connect the new page to the main site via a link, in a wiki you first have to create the link and then the page. When you create the link, it will be to a blank page. Then when you click on this blank page, it will give you the option of adding content, so that it’s no longer blank. | |||
#Therefore, the first thing to do is decide where your halachik article would belong within our topical categories as displayed on the left sidebar. | |||
## For instance, “The [[Laws of Shema]]” would fall within the “[[Prayer]]” category. | |||
#Next, you need to create the link. To do this, click the edit tab towards the top of the page. From here you’ll see a large editable text box with all sorts of strange looking coding symbols. Find where you should add your link and surround the title with double brackets | |||
## For instance <nowiki>[[Laws of Shema]]</nowiki> = [[Laws of Shema]] | |||
# A red link means that it's an empty page, which you can then click on and add content | |||
== How to Add Content == | == How to Add Content == | ||
| Line 78: | Line 96: | ||
<references/>” | <references/>” | ||
</pre> | </pre> | ||
==How to Add A Picture== | |||
# Upload the picture here: [[Special:Upload]] | |||
# Go to the page you want to add a picture and click the picture icon (fifth icon) and follow instructions. OR type in <pre>[[Image:filename.png|right|200px]]</pre> where filename is replaced by the correct filename, right is the side of the page the image should appear, and 200 is the picture width. | |||
== How to Change Page Titles == | |||
# Go to the page you desire to change the title. | |||
# Click on the "Move" tab that is found in the dropdown menu next to read, edit, and view history. | |||
# Choose a new name and click "Move Page". You're done. | |||
# To ensure that the redirects aren't messed up, check here and fix accordingly: [[Special:DoubleRedirects]] | |||
== Transliteration from Hebrew to English == | == Transliteration from Hebrew to English == | ||
We hope to offer a dynamic interface that allows the user to choose his transliteration or pronunciation style (Ashkenazic, Sephardic) and the text will appear accordingly. However, until we can implement this feature this is what we have:<br> | We hope to offer a dynamic interface that allows the user to choose his transliteration or pronunciation style (Ashkenazic, Sephardic) and the text will appear accordingly. However, until we can implement this feature this is what we have:<br> | ||
| Line 89: | Line 115: | ||
Halachipedia adopts the "Title case" for its style of capitalizing page and section titles. The rules of "Title case" are as follows: | Halachipedia adopts the "Title case" for its style of capitalizing page and section titles. The rules of "Title case" are as follows: | ||
* Capitalize the first and last word in a title, regardless of part of speech | * Capitalize the first and last word in a title, regardless of part of speech | ||
* Capitalize all | * Capitalize all nouns (baby, country, picture), pronouns (you, she, it, which), verbs (walk, think, dream), adjectives (sweet, large, perfect), adverbs (immediately, quietly), and subordinating conjunctions (as, because, although) | ||
For example: How to Edit Halachipedia (all words capitalized except “to,” which is | * Lowercase all articles (a, the), prepositions (to, of, at, in, with, on, during, into), and coordinating conjunctions (for, and, nor, but, or, yet, and so) | ||
<br>See [http://www.dailywritingtips.com/rules-for-capitalization-in-titles/ Dailywritingtips.com for details.] | * Lowercase “to” as part of an infinitive. | ||
* "That" should be capitalized whether it is used as a pronoun (referring to a person, place, or thing, such as "''that'' is the halacha"), relative pronoun (beginning a subordinate clause that shares an argument with the main clause, such as "[[Melacha That Begins Before Shabbat]]"), or a subordinating conjunction (introducing clause about the subject, such as "the halacha is ''that'' it is permitted"). | |||
# For example: How to Edit Halachipedia (all words capitalized except “to,” which is part of an infinitive). <br>See [http://www.dailywritingtips.com/rules-for-capitalization-in-titles/ Dailywritingtips.com for details.] | |||
# For example: "Telling a Non-Jew on [[Shabbat]] to Work After [[Shabbat]]" all words are capitalized except for: a (article), on (preposition), and to (infinitive). | |||
==Capitalizing Hebrew Words== | |||
In general, the capitalization depends on whatever would be capitalized in English. | |||
# Rule 1: The first word of a sentence is always capitalized | |||
# Rule 2: A proper noun is capitalized. A proper noun is a name for an specific person, place, or organization. | |||
## For example, Shabbat is a proper noun just like Saturday would be and should be capitalized. However, a bracha should be lowercase just like a blessing is a noun and is lowercase, though, Birchot HaTorah would be capitalized for that matter. | |||
## Another example, is that the word 'rishonim' (Medeval commentators) shouldn't be capitalized, but Tosfot should be since it refers to a specific group of French rabbis living in the Twelfth century. | |||
==Page Classification== | ==Page Classification== | ||
| Line 98: | Line 134: | ||
# Lacking - The page has anywhere from 3 to 10 halacha's. | # Lacking - The page has anywhere from 3 to 10 halacha's. | ||
# Okay - The page still can be improved significantly. Either it lacks content depending on the topic, it lacks structure, or needs updating. | # Okay - The page still can be improved significantly. Either it lacks content depending on the topic, it lacks structure, or needs updating. | ||
# Good - The page can still be improved. It can have more content, pictures, or organization | # Good - The page can still be improved. It can have more content, pictures, or organization. | ||
# Done - The page is a finished product. It can only be edited by administrators | # Done - The page is a finished product. It can only be edited by administrators. | ||
The | The five classifications will look as follows: | ||
{{Stub}} | {{Stub}} | ||
{{Lacking}} | {{Lacking}} | ||
{{Okay}} | {{Okay}} | ||
{{Good}} | |||
{{Done}} | |||
To implement this classification, simply put one of the following lines at the top of a page of content: <nowiki>{{Stub}}, {{Lacking}}, {{Okay}}, {{Good}}, {{Done}}</nowiki><br> | To implement this classification, simply put one of the following lines at the top of a page of content: <nowiki>{{Stub}}, {{Lacking}}, {{Okay}}, {{Good}}, {{Done}}</nowiki><br> | ||
Please help us implement this classification system. We can utilize this classification to devote our attention to the pages which need the most help, by seeing the following lists: | Please help us implement this classification system. We can utilize this classification to devote our attention to the pages which need the most help, by seeing the following lists: | ||
#[[Special:WhatLinksHere/Stub]] | #[[Special:WhatLinksHere/Template:Stub]] | ||
#[[Special:WhatLinksHere/Lacking]] | #[[Special:WhatLinksHere/Template:Lacking]] | ||
#[[Special:WhatLinksHere/Okay]] | #[[Special:WhatLinksHere/Template:Okay]] | ||
#[[Special:WhatLinksHere/Good]] | #[[Special:WhatLinksHere/Template:Good]] | ||
#[[Special:WhatLinksHere/Done]] | #[[Special:WhatLinksHere/Template:Done]] | ||
==Overlapping Content== | |||
If content is relevant to two separate pages, our goal is to make the content available to users whichever page they are reading. If one of the pages is the primary one and the other is secondary, the content should be written on the primary page and the secondary one should just have a reference to the primary page. On the other hand, if the halacha is very relevant to both pages, it should be included on both pages. However, the pages should be coordinated so that changes on one page also appear on the other. The current solution is to use templates. To do this, create a [[template]] and insert the halacha and the relevant footnotes into the [[template]]. Then include the [[template]] whether it belongs. <br> | |||
For example, see the [[template]] for Writings on the Side of Pages: [[Template:Writing_on_the_Side_of_Books]]. Here are the pages where it is included: | |||
* [[Kotaiv]] | |||
* [[Mochek]] | |||
* [[Books, notebooks, and papers]] | |||
==Other Templates== | ==Other Templates== | ||
===Incomplete Sections=== | |||
To indicate that only a section is lacking use: <nowiki>{{SectionLacking}}</nowiki>. This is displayed as follows: | |||
{{SectionLacking}} | {{SectionLacking}} | ||
===Missing Source=== | |||
If a halacha is missing a source, it should be marked clearly so that it can be corrected or removed quickly. It is included with the following code:<nowiki>{{NoSource}}</nowiki> and it displays as follows:<br/> | |||
{{NoSource}} | {{NoSource}} | ||
===Questionable Page=== | |||
Use this [[template]] if a page has very questionable content or a topic that does not belong on Halachipedia. | |||
It is included with <nowiki>{{QuestionablePage}}</nowiki> and it displays as follows:<br/> | |||
{{QuestionablePage}} | {{QuestionablePage}} | ||
===Ibid in Sources=== | |||
Ibid is discouraged because of the inflexibility it causes to the growing site. This [[template]] is included with the following: <nowiki>{{Ibid}}</nowiki> and it displays as follows: | |||
{{Ibid}} | {{Ibid}} | ||
<br /><nowiki>{{ | ===Reference Columns=== | ||
Pages that have a lot of sources could look nicer with 2 column or 3 columns. This is currently implemented on the [[Tefillin]] page and [[Chol HaMoed]] page. It is included by replacing <nowiki><references/> with {{Reflist|2}} or {{Reflist|3}}.</nowiki><br> | |||
Currently, we're using reference highlights with a little CSS to make it easier to find which footnote you are up to. See the [[Mediawiki:Vector.css]] page for that code. | |||
==How to Categorize a Page== | |||
The categorization system is very useful for organizational purposes. At the bottom of every page should be a category link. All you have to do is add the following at the bottom of a page: <nowiki>[[Category:Category_Name]]</nowiki>.<br> | |||
The next question is how to create a Category. Simple. | |||
* Go to the following URL: | |||
* Click the Create Tab (top right) | |||
* Type <nowiki>{{cat main}}</nowiki> | |||
* Save page. Done. | |||
Here's an example of a Category page: [[Category:Chanukah]]. | |||
==Get Halachipedia Offline== | |||
# See [[Get Halachipedia Offline]] | |||
==Links for More Coding Help== | ==Links for More Coding Help== | ||
* [http://en.wikipedia.org/wiki/Help:Cheatsheet Wiki Markup Cheatsheet] | * [http://en.wikipedia.org/wiki/Help:Cheatsheet Wiki Markup Cheatsheet] | ||
* [http://www.mediawiki.org/wiki/Help:Formatting Wiki] | * [http://www.mediawiki.org/wiki/Help:Formatting Wiki Formatting Help Page] | ||
