community:wiki:style_page
Differences
This shows you the differences between two versions of the page.
Both sides previous revisionPrevious revision | |||
community:wiki:style_page [2012/07/05 21:59] – rpc | community:wiki:style_page [2014/12/27 04:40] (current) – external edit 127.0.0.1 | ||
---|---|---|---|
Line 1: | Line 1: | ||
+ | FIXME \\ | ||
+ | This section is still undergoing revision and will be modified as time passes.\\ | ||
+ | \\ | ||
+ | Please take note that there is a [[: | ||
+ | BRIEF REVIEW: | ||
+ | ^Section^Summary^ | ||
+ | |Adding Links|add links so that they don't have the [[http:// | ||
+ | |Anecdote|A clear organized wiki should not have [[http:// | ||
+ | |Namespaces|Namespaces should be clearly documented and followed, there will be a list of namespaces and their purposes coming shortly| | ||
+ | |Images|Place images in the same namespace as the page that the editor is working on, except for ships and stations, which have a separate namespace| | ||
+ | |Community Descriptions|It' | ||
+ | ===== The Elements of Style ===== | ||
+ | This page should be read after one has read the [[: | ||
+ | This page was written to reflect the fact that there are a growing number of editors to the wiki that may or may not be familiar with dokuwiki, and reflects the need that some writing conventions need to be written down to create a cohesive style for the wiki so as to not create conflicting styles and varying quality. | ||
+ | |||
+ | ==== How to add links ==== | ||
+ | Although it's best to link using the URL (as it will be more stable), using the syntax that does not engender the [[http:// | ||
+ | Thus, [[http:// | ||
+ | This results in the use of links such as these: [[game/ | ||
+ | | ||
+ | [[game/ | ||
+ | |||
+ | These links have the namespace in front of the page, and it is always best to have it just in case a page gets moved. Although pages within the :Awesome namespace don't require the use of :awesome while linking to other pages within the awesome namespace, it is still a better choice to have include the namespace. Most items and pages on this wiki do not have a namespace as of yet, so this will not be in effect until a still undecided namespace move occurs in the future.\\ | ||
+ | Also take note that even a single space may be the deciding factor for the formatting of a page. | ||
+ | For example, "\\ " will break a new line, but not so with " | ||
+ | I suggest clicking at the edit this page button if anyone is curious. \\ | ||
+ | \\ | ||
+ | Keep in mind that making great and effective links is VERY IMPORTANT.\\ | ||
+ | \\ | ||
+ | === Personal Anecdote time === | ||
+ | I know the style page is not the place for a personal anecdote, but I encountered [[http:// | ||
+ | |||
+ | ==== Namespaces ==== | ||
+ | Ever since the [[http:// | ||
+ | \\ | ||
+ | Namespaces are what define a group or cluster of pages. They are important because the wiki groups pages through namespaces, and there was long list of items that used to clutter up the [[http:// | ||
+ | \\ | ||
+ | Namespaces are set up when creating a link to a page that looks like this: namespace: nameofpage. This would lead to issues because new editors don't know old namespaces, old editors don't write down how they organize into namespaces, and then things become a mess. \\ | ||
+ | \\ | ||
+ | Therefore, it is VITAL to make sure new pages get created in the proper namespace, and to be diligent when creating links\\ | ||
+ | ==== Images ==== | ||
+ | [[http:// | ||
+ | \\ | ||
+ | As with namespaces, the media files on the wiki are also separated in a similar way. \\ | ||
+ | There is actually a place to put all images that corresponds with all the namespaces in the wiki, so just place images in the same image namespace as the wiki page they are on. The exception is the ship and station images, which have their own namespace. | ||
+ | |||
+ | ==== Community Descriptions ==== | ||
+ | It's ok to use all [[http:// | ||
+ | Some [[game/ | ||
+ | \\ | ||
+ | ==== Final Reminder ==== | ||
+ | As a final reminder, thanks for deciding to help out on the wiki and helping out the Transcendence community. Here are some links to get started: [[http:// |