Difference between revisions of "Howto"

From bombaywiki
Jump to: navigation, search
 
(46 intermediate revisions by 2 users not shown)
Line 1: Line 1:
[https://bombaywiki.with.camp bombaywiki.with.camp] is a collaborative, wiki type, subjective encyclopedia of Bombay.
+
[https://bombaywiki.with.camp bombaywiki.with.camp] is a collaborative, wiki type, subjective encyclopedia of Bombay/Mumbai.
  
* Red links - link created, page auto-created by clicking on a red link, to then be populated.
+
==== Writing Style ====
 +
* This wiki encourages subjective and opinionated writing in its pages.
 +
* Sources can vary from personal experience, oral sources, books to newspapers, etc. but it is NOT necessary to reference every fact or claim. Bombaywiki is interested in ideas that grow around things, places, people. Authors' particular voices are encouraged, and are credited in the History of each page/ entry. Textual sources if any can be placed in the bottom of a page, under the heading Further Reading. An example is: [[Anna_Bhau_Sathe#Further_Reading:]].
 +
* First person accounts are encouraged, and should be placed in <block quotes> eg. [[Mohammad_Umar]].
 +
* Linking to external sites in the text should be done only when absolutely necessary for context, for example to link to the full text of a poem. Place other links and sources in Further Reading. Other pages in the wiki should be linked to where needed. For how-to, see the Adding Links section below.
 +
 
 +
==== The Index ====
 +
is the [[Index|Main Page]] of the wiki. It has groups of entities (People, Places, Organizations, Events, Things, Concepts, Interpretations etc), each alphabetically sorted.
 +
* Red links - there is no page yet, page is created by clicking on the red link, to then be populated.
 
* Blue links - links to pages already populated, open to editing.
 
* Blue links - links to pages already populated, open to editing.
  
=== To contribute: ===
+
==== To Begin Contributing ====
 +
* Register on [[Index|bombaywiki.with.camp]]: On top-right, click "Guest" -> "Create Account"
 +
* Send us an email to grant you edit access, and mention your username. Email to: contact+bombaywiki@studio.camp
 +
* Entries are to be added alphabetically per section on the main page, which serves as an index/overview of the site. Click the edit button in front of each section to begin.
 +
** Each entry on this page is a link to a page of that name.
 +
* Creating a new entry in index
 +
** To create a new entry called "Carrom" in section Things, click "Edit" next to the title of Things section, scroll to appropriate alphabetical position.
 +
** Create a new line, type as below then 'Save':<br>
 +
  <nowiki>[[Carrom]]<br></nowiki>
 +
* This creates a link, and a line break after it. Click on the link, you will see this message:
 +
"You have followed a link to a page that does not exist yet. To create the page, start typing in the box below (see the help page for more info). If you are here by mistake, click your browser's back button."<br>
 +
* You can now add text, add links and embed image/audio/video files. Once complete, "Save Changes".
 +
* You may use "Show Preview" to see what the page looks like without saving it. Save when satisfied.
  
* Register on [[Index|bombaywiki.with.camp]]: Top-right, click "Guest" -> "Create Account"
+
==== Helpful Tips ====
* Send us an email to grant you edit access, mention your username
+
on how to format text, add links, embed images/audio/video files:
* Entries are to be added alphabetically per section to the main page which serves as an index of the site.
 
** Each entry on this page is a link to a page of that name.
 
** For example to create a new entry called "New Entry", click "Edit" on top, scroll to appropriate heading and alpahabetical position.
 
** Type as below then 'Save':<br>
 
  <nowiki>[[New Entry]]<br></nowiki>
 
** This creates a link. Click on it, you will see this message:
 
"There is currently no text in this page. You can search for this page title in other pages, search the related logs, or create this page"<br>
 
** Click on "create this page" and populate. Once complete, "Save Changes".
 
  
 
+
===== Formatting text =====
 
+
You can format your text by using wiki "markup" that is use of symbols to create variations in text style.<br>
=== Documentation and help links: ===
+
* See https://www.mediawiki.org/wiki/Help:Formatting<br>
 
+
* For example:
* Formatting: You can format your text by using wiki markup.<br>
+
{| class="wikitable" style="margin: auto;"
** See https://www.mediawiki.org/wiki/Help:Formatting<br>
+
|'''what you type'''
** For example:<br>
+
|'''text enclosed in'''
{| class="wikitable"
+
|'''to see'''
|'''formatted text'''
 
|'''syntax'''
 
 
|-
 
|-
 +
|<nowiki>'''bold'''</nowiki>
 +
|3 single quotes
 
|'''bold'''
 
|'''bold'''
|<nowiki>'''bold'''</nowiki>
 
 
|-
 
|-
 +
|<nowiki>''italic''</nowiki>
 +
|2 single quotes
 
|''italic''
 
|''italic''
|<nowiki>''italic''</nowiki>
 
 
|}
 
|}
  
* Adding links: https://www.mediawiki.org/wiki/Help:Links
+
* Creating headings within a page
 +
Headings can be  of levels 2-6 (most practically 3-6), created by enclosing text in "=" on a new line ,as per heading level.<br> Do not put any text on the same line after the ending equal signs.<br> '''An article with 4 or more headings automatically creates a table of contents.'''
 +
 
 +
<nowiki>=== Heading Level 3 ===</nowiki>
 +
<nowiki>==== Heading Level 4 ====</nowiki>
 +
<nowiki>===== Heading Level 5 =====</nowiki>
 +
 
 +
* Paragraphs
 +
MediaWiki ignores single line breaks. To start a new paragraph, leave an empty line.<br> You can force a line break within a paragraph with the HTML tag <nowiki><br></nowiki>
  
* Uploading files:
+
* Start a line with a space to create a "box" in which your text will appear.
** Files (png, gif, jpg, jpeg, webp, pdf, webm, mp4, mp3) can be uploaded, to embed or link-to as required on relevant pages.<br>
+
This is pre-formatted text which appears in a "box".
** Filename should be complete and informative. (example: Books should have author, title, publication year in the title)<br>
 
** Prepare the file, go to "Upload File" button, top-left on bombaywiki.<br>
 
** Add useful information in the "Summary" section of the upload file form - a blurb, tags, or metadata like Book Author, etc.<br>
 
** More help here: https://www.mediawiki.org/wiki/Help:Managing_files
 
  
* To find uploaded files see these links in bombaywiki left-panel:
+
===== Adding links =====
** [[Special:ListFiles|All Files]] - list of all files uploaded to the wiki in a tabular format with title, metadata, description visible<br>
+
* See detailed documentation: https://www.mediawiki.org/wiki/Help:Links
** [[Special:NewFiles|Recent Files]] - thumbnail/icon with title list of recently uploaded files.
+
Internal link basic format:  
 +
<nowiki>[[target-item|text-displayed]]</nowiki>
 +
External link basic format:
 +
<nowiki>[[url text-displayed]]</nowiki>
  
 +
* Some examples:
 +
{| class="wikitable" style="margin: auto;"
 +
|'''what you type'''
 +
|'''to see'''
 +
|'''link type'''
 +
|-
 +
|<nowiki>[https://pad.ma]</nowiki><br><nowiki>[https://pad.ma/CW]</nowiki>
 +
|[https://pad.ma]<br>[https://pad.ma/CW]
 +
|link to external site, no link-text<br>Multiple links of this type on<br> the same page are numbered sequentially.
 +
|-
 +
|<nowiki>[https://pad.ma video archive]</nowiki>
 +
|[https://pad.ma video archive]
 +
|link to external site, link-text "video archive"
 +
|-
 +
|<nowiki>[[Anna Bhau Sathe]]</nowiki>
 +
|[[Anna Bhau Sathe]]
 +
|internal link within bombaywiki
 +
|-
 +
|<nowiki>[[Anna_Bhau_Sathe#SHORT_STORIES|Anna's short stories]]</nowiki>
 +
|[[Anna_Bhau_Sathe#SHORT_STORIES|Anna's short stories]]
 +
|internal link to specific section, hyperlink
 +
|}
 +
 +
===== Uploading files =====
 +
* Files (png, gif, jpg, jpeg, webp, pdf, webm, mp4, mp3) can be uploaded, to embed or link-to as required on pages.<br>
 +
* Filename should be complete and informative. <br>For example: Books should have author, title, publication year in the title)
 +
* Documents (PDF) and images should be uploaded at their original resolution. You can resize them for viewing later.
 +
* Maximum file size is 64MB.
 +
* To upload click "Upload File" button, top-left on bombaywiki.
 +
* Add a summary or description or tags in the "Summary" section of the upload file form.<br> Click "Upload File" button at bottom of the page.
 +
* To find and use uploaded files see these links in bombaywiki left-panel:
 +
** [[Special:ListFiles|All Files]]<br> - list of all files uploaded to the wiki in a tabular format with title, metadata, description visible<br>- can be sorted by any field by clicking on field heading.
 +
** [[Special:NewFiles|Recent Files]]<br> - list of recently uploaded files, title with thumbnail.
 +
** Note: click on a file in the list takes you to the file description page.
 +
* More help: https://www.mediawiki.org/wiki/Help:Managing_files
 +
 +
===== Using files =====
 
* To Link and Display files see links in bombaywiki left-panel:
 
* To Link and Display files see links in bombaywiki left-panel:
** [https://www.mediawiki.org/wiki/Help:Images Display Images]
 
 
** [[PDF_help|Link and Embed PDF]]
 
** [[PDF_help|Link and Embed PDF]]
 +
** [[Image_Help|Display Images]]
 
** [[AVembed|Embed Audio-Video files]]
 
** [[AVembed|Embed Audio-Video files]]
  
 
+
===== Embedding video from external sites =====
* Embedding video from external sites like pandora based https://pad.ma or https://indiancine.ma (https://wiki.pad.ma/wiki/embed)
+
* [https://wiki.pad.ma/wiki/embed From pad.ma or indiancine.ma]

Latest revision as of 17:56, 27 November 2017

bombaywiki.with.camp is a collaborative, wiki type, subjective encyclopedia of Bombay/Mumbai.

Writing Style

  • This wiki encourages subjective and opinionated writing in its pages.
  • Sources can vary from personal experience, oral sources, books to newspapers, etc. but it is NOT necessary to reference every fact or claim. Bombaywiki is interested in ideas that grow around things, places, people. Authors' particular voices are encouraged, and are credited in the History of each page/ entry. Textual sources if any can be placed in the bottom of a page, under the heading Further Reading. An example is: Anna_Bhau_Sathe#Further_Reading:.
  • First person accounts are encouraged, and should be placed in <block quotes> eg. Mohammad_Umar.
  • Linking to external sites in the text should be done only when absolutely necessary for context, for example to link to the full text of a poem. Place other links and sources in Further Reading. Other pages in the wiki should be linked to where needed. For how-to, see the Adding Links section below.

The Index

is the Main Page of the wiki. It has groups of entities (People, Places, Organizations, Events, Things, Concepts, Interpretations etc), each alphabetically sorted.

  • Red links - there is no page yet, page is created by clicking on the red link, to then be populated.
  • Blue links - links to pages already populated, open to editing.

To Begin Contributing

  • Register on bombaywiki.with.camp: On top-right, click "Guest" -> "Create Account"
  • Send us an email to grant you edit access, and mention your username. Email to: contact+bombaywiki@studio.camp
  • Entries are to be added alphabetically per section on the main page, which serves as an index/overview of the site. Click the edit button in front of each section to begin.
    • Each entry on this page is a link to a page of that name.
  • Creating a new entry in index
    • To create a new entry called "Carrom" in section Things, click "Edit" next to the title of Things section, scroll to appropriate alphabetical position.
    • Create a new line, type as below then 'Save':
  [[Carrom]]<br>
  • This creates a link, and a line break after it. Click on the link, you will see this message:
"You have followed a link to a page that does not exist yet. To create the page, start typing in the box below (see the help page for more info). If you are here by mistake, click your browser's back button."
  • You can now add text, add links and embed image/audio/video files. Once complete, "Save Changes".
  • You may use "Show Preview" to see what the page looks like without saving it. Save when satisfied.

Helpful Tips

on how to format text, add links, embed images/audio/video files:

Formatting text

You can format your text by using wiki "markup" that is use of symbols to create variations in text style.

what you type text enclosed in to see
'''bold''' 3 single quotes bold
''italic'' 2 single quotes italic
  • Creating headings within a page

Headings can be of levels 2-6 (most practically 3-6), created by enclosing text in "=" on a new line ,as per heading level.
Do not put any text on the same line after the ending equal signs.
An article with 4 or more headings automatically creates a table of contents.

=== Heading Level 3 ===
==== Heading Level 4 ====
===== Heading Level 5 =====
  • Paragraphs

MediaWiki ignores single line breaks. To start a new paragraph, leave an empty line.
You can force a line break within a paragraph with the HTML tag <br>

  • Start a line with a space to create a "box" in which your text will appear.
This is pre-formatted text which appears in a "box".
Adding links

Internal link basic format:

[[target-item|text-displayed]]

External link basic format:

[[url text-displayed]]
  • Some examples:
what you type to see link type
[https://pad.ma]
[https://pad.ma/CW]
[1]
[2]
link to external site, no link-text
Multiple links of this type on
the same page are numbered sequentially.
[https://pad.ma video archive] video archive link to external site, link-text "video archive"
[[Anna Bhau Sathe]] Anna Bhau Sathe internal link within bombaywiki
[[Anna_Bhau_Sathe#SHORT_STORIES|Anna's short stories]] Anna's short stories internal link to specific section, hyperlink
Uploading files
  • Files (png, gif, jpg, jpeg, webp, pdf, webm, mp4, mp3) can be uploaded, to embed or link-to as required on pages.
  • Filename should be complete and informative.
    For example: Books should have author, title, publication year in the title)
  • Documents (PDF) and images should be uploaded at their original resolution. You can resize them for viewing later.
  • Maximum file size is 64MB.
  • To upload click "Upload File" button, top-left on bombaywiki.
  • Add a summary or description or tags in the "Summary" section of the upload file form.
    Click "Upload File" button at bottom of the page.
  • To find and use uploaded files see these links in bombaywiki left-panel:
    • All Files
      - list of all files uploaded to the wiki in a tabular format with title, metadata, description visible
      - can be sorted by any field by clicking on field heading.
    • Recent Files
      - list of recently uploaded files, title with thumbnail.
    • Note: click on a file in the list takes you to the file description page.
  • More help: https://www.mediawiki.org/wiki/Help:Managing_files
Using files
Embedding video from external sites