Both sides previous revisionPrevious revisionNext revision | Previous revision |
conventions [2012/07/25 22:33] – ch1b1 | conventions [2019/12/11 04:49] (current) – switch to namespaced tags ch1b1 |
---|
| |
#REDIRECT where_the_page_should_point_to | #REDIRECT where_the_page_should_point_to |
| |
| More tips on using links: |
| * Include links to pages that don't exist yet---this will encourage someone to create them. |
| * Create pages that are linked to but don't exist yet. An orange link is an invitation. |
| * Avoid changing page names and section titles, as others may link to them. |
| * If you and another contributor disagree on what the name of a page should be---i.e., your links to it have different names---just put in a redirect and be done with it. |
| |
==== Tag, You're It ==== | ==== Tag, You're It ==== |
{{tag>some tags here}} | {{tag>some tags here}} |
| |
where each tag is separated by a space. Tag names may not have spaces in them. You might want to consider tagging pages about your locations with your username---that way, you can find them later. | where each tag is separated by a space. Tag names may not have spaces in them. You might want to consider tagging pages about your locations with your username---that way, you can find them later. All tags are namespaced with colons. A leading colon uses the root namespace. |
| |
Certain tags are magical---they will make the wiki software link to your page automatically. These magical tags include: | Certain tags are magical---they will make the wiki software link to your page automatically. These magical tags include: |
* ''location'': Anything which describes a point, area, or region in the world should be tagged as a location. There are several specific types of location tags. These tags should be included **in addition** to the ''location'' tag. | * '':location'': Anything which describes a point, area, or region in the world should be tagged as a location. There are several specific types of location tags. These tags should be included **in addition** to the ''location'' tag. |
* ''home'': Any permanently-inhabited space, such as the one in which your character resides. You can have more than one home. Any page with this tag will be listed on the start page. | * '':home'': Any permanently-inhabited space, such as the one in which your character resides. You can have more than one home. Any page with this tag will be listed on the start page. |
* ''landmark'': If you've spent five hours building a complicated model of something, and you want everyone to see it, include this tag. Landmarks are also listed on the start page. | * '':landmark'': If you've spent five hours building a complicated model of something, and you want everyone to see it, include this tag. Landmarks are also listed on the start page. |
* ''player'': Your user page should contain this tag. User pages are of supreme importance and are linked to, prominently, on the [[start]] page. | * '':technology'': Machines can be art, too! It doesn't have to look good, but it does have to be useful. If you've built some technology at a //specific location// you want others to see and use, give it this tag. |
It is worth nothing that these magical tags all use the singular form---i.e., ''player'' instead of ''player<del>s</del>.'' | * '':player'': Your user page should contain this tag. User pages are of supreme importance and are linked to, prominently, on the [[start]] page. |
| It is worth nothing that these magical tags all use the singular form---i.e., '':player'' instead of '':player<del>s</del>.'' |
| |
There are other tags which are not magical right now, but if they become popular enough they will gain their own wiki page. These tags are: | There are other tags which are not magical right now, but if they become popular enough they will gain their own wiki page. These tags are: |
* ''info'': Generic information about the world that is not location-specific. | * '':info'': Generic information about the world that is not location-specific. |
* ''blueprint'': Plans, schematics, and designs. | * '':blueprint'': Plans, schematics, and designs. |
* ''region'': An article describing a large area of the world. | * '':region'': An article describing a large area of the world. |
* ''your_tag'': If you want to propose more standardized tags, include them here! | * '':your_tag'': If you want to propose more standardized tags, include them here! |
| |
Tag magic is easy to learn---the incantation is relatively straightforward. Anyone can automatically generate a list of pages with one or more tags. If you've tagged a bunch of pages as ''butterflies'' and you want to list all pages which are tagged ''butterflies,'' just use | Tag magic is easy to learn---the incantation is relatively straightforward. Anyone can automatically generate a list of pages with one or more tags. If you've tagged a bunch of pages as '':butterflies'' and you want to list all pages which are tagged '':butterflies,'' just use |
{{topic>butterflies}} | {{topic>:butterflies}} |
and such a list will be inserted into your page. The syntax for the tagging engine is described on an [[http://www.dokuwiki.org/plugin:tag|external website]] and not on the main syntax page. | and such a list will be inserted into your page. The syntax for the tagging engine is described on an [[http://www.dokuwiki.org/plugin:tag|external website]] and not on the main syntax page. |
| |
==== Content Checklist ==== | ==== Content Checklist ==== |
| The content of the page is left largely to the discretion of the author, but here are a few suggestions. |
| * Use lots of images... but many snapshots of the same thing should go in a slide-show. |
| * Use a spell checker. |
| * Leave space to expand your pages in the future. |
| * Make use of section headings and, if you're linking to a very long page, anchor links. |
| * Consider using topic pages such as [[DTA Minecarts]] which redirect to a subsection of another page (in this case, ''Dwarven Transit Authority#Minecarts'') |
| * When pages get too long, split them. |
| * Pages which describe locations should... |
| * include coordinates and directions |
| * describe and link to what is nearby |
| * link to the creator's user page |
| * have the appropriate tags, including ''location'' and the name of the creator(s) |
| * Medium-sized locations should be divided into subsections |
===== Multimedia ===== | ===== Multimedia ===== |
| "Pics or it didn't happen" is the battle cry of the modern internet warrior. Minecrafters have instant access to a high-quality digital camera, and there is no reason not to use it. Authors are encouraged to upload screenshots, maps, logos, and anything else they feel would enhance the quality of their pages. You can even include blueprints or schematic files of your creations in order to share them with the world. Videos should be hosted [[http://www.youtube.com/|elsewhere]], however, as the server has insufficient bandwidth to support them. |
| |
| Multimedia can be difficult to organize or retrieve---the tagging engine doesn't work for media files---and careful organization is necessary. |
| |
| ==== Namespaces ==== |
| A namespace in dokuwiki is like a folder on a file system. Namespaces are represented in dokuwiki with colons (":"). The following namespaces are recommended for image files: |
| |
| * ''avatar:'' Any Minecraft skin, user avatar, or line-art logo. |
| * ''blueprint:'' How-to instructions for a build. Please do not use screenshots to post blueprints; they usually look terrible. |
| * ''map:'' Maps, either actual or logical, of the world. |
| * ''screenshot:'' Any in-game screenshot (i.e., captured with F2) |
| |
| Once again, namespaces use the singular form of the word. Feel free to create your own name-spaces and organize them. If you've got a bunch of cool screen shots of your treehouse, perhaps you should file them under ''screenshot:cool_treehouse.'' Organization is particularly crucial if you want to present multi-image slide shows. |
| |
| The namespace ''screenshot:featured'' is magical, and anything you upload there will be placed in the [[featured|Featured Screenshots]] slide show. The ''featured'' slide show is intended to exhibit the best things on the server, and "B-roll" images of digging needlessly-giant holes are probably best placed elsewhere. |
| |
| ==== Uploading ==== |
| To upload an image, click on the "Add Images" button in the toolbar. All files should have a descriptive name. Names such as "''Sherwood_Forest_On_Fire.png''" are far superior to names like "''1970-01-01_00.00.00.png''." It is not possible to change the name, or namespace, of an image once it has been uploaded, so choose it carefully the first time. If you make a mistake, delete the unwanted file and upload it again. |
| |
| Feel free to use images that other people have uploaded in your own pages. |
| |
| ==== Using Images ==== |
| The media manager can be used to insert an image into your current page. To keep loading times to a minimum, use only thumbnail-sized images (i.e., small or medium-sized) in your pages. The [[wiki:syntax#images_and_other_files|syntax page]] lists the built-in commands for including images, but several plugins are in use on this wiki that further improve image display. |
| |
| To create a "boxed" image with an inset caption, wrap your image syntax in brackets ("[]"). For example, |
| [{{my_first_cake.png?120|... but I eated it. }}] |
| inserts an image on the left side of the page that is 120 pixels wide, in a box, with the text "... but I eated it" beneath it. Wiki markup may be included in the caption text. This command is ideal for including a single image, but multiple images require the use of the gallery plugin. |
| |
| The gallery plugin can be used to view an entire [[#namespaces|namespace]] as a slide-show. It can also include just a single image or a wild-card image search. The media manager includes an option to "Add namespace as gallery," which will insert a basic photo gallery of the selected namespace. Read the [[http://www.dokuwiki.org/plugin:gallery|gallery syntax]] for the full list of features---there are lots of options. A good example of the syntax is included on the [[featured screenshots]] page: |
| {{gallery> screenshot:featured?&lightbox&3&showname&modsort&reverse }} |
| inserts a photo gallery of all photos in the ''screenshot:featured'' namespace. Three columns of images are included per row, sorted by upload date with the most recent first. When clicked, the image will pop up in a full-screen slide-show view that can be scrolled through with the arrow keys---this is the ''lightbox'' option. |
| |
| It is also possible to insert just a single image using ''gallery''. If multiple ''gallery'' invocations are given on the same page, you can scroll through all of the images in the popup ''lightbox'' view. Sadly, it is not possible to include captions using the ''gallery'' plugin. |