====== Contribution Guide ====== Please review the contents of this page to understand how DokuWiki is implemented and the methods you can use to contribute pages. ===== What do I need to edit the site? ===== All you need to do is join [[https://discord.gg/Tc3Nev9mhh|our Discord server]] and be assigned the ''@Brahe Crew'' role. That usually means at least one active character in the community. Once you have the assigned roll, the site's login button will work for you. We use Discord as our [[https://en.wikipedia.org/wiki/OAuth|Oauth]] provider. It works just like the ''Login with Google'' or ''Login with Facebook'' buttons you may see on other websites. ===== What can I edit? ===== Anything the site gives you permission to edit, including pages you didn't create. Why? It takes a village to ensure the information on this site is current and correct. //Brahe// has been ongoing for six years, with no plans on stopping anytime soon. There are many people, places, and things which need to be kept current. ===== How do I Create a Page? ==== Creating a page has a few steps to get it just right: * In the search bar, type ''lcars:'' followed by the page you want to create * Use lower case * Replace non-alphanumeric characters (such as the apostrophe) with an underscore ''_'' * Click the __red link__ after the message ''If you didn't find what you were looking for, you can create or edit the page'' Once in the editor window, use ''Preview'' to check the contents of your new page to make sure it looks how you want it to. Then, use ''Save'' to finalize the changes. Refer to the syntax guide below for more information on how to format your page. Example: to create the page for ''Tri'a K'mnzi'', you would search for ''lcars:tri_a_k_mnzi''. This ensures that when you link a page using the double-brackets syntax (ignoring the slashes) ( ''\[\[Tri'a K'mnzi\]\]'' ), it links automatically to the page. ===== Syntax ===== DokuWiki does not use the familiar Markdown language which Discord and Discourse uses. Instead, it uses a special Wiki syntax which can be thought of us as progenitor to Markdown. Instead of reproducing the individual guides, we'll link to the different sites which contain detailed instructions. ^ Guide ^ Description ^ | [[https://www.dokuwiki.org/wiki:syntax#image_links|DokuWiki General Syntax]] | General language guide for this site. | | [[https://www.dokuwiki.org/images|DokuWiki Images]] | Instructions on how to embed images | | [[https://www.dokuwiki.org/plugin:commentsyntax#examples_usage|Comments]] | Create hidden comments inside documents. | | [[https://www.dokuwiki.org/plugin:folded#usage|Folded Plugin]] | Collapse sections of the page to reduce clutter. | | [[https://github.com/Kanaru92/DokuWiki-InfoBox|Infobox Plugin]] | For modifying the right-hand summary box. | | [[https://www.dokuwiki.org/plugin:tag#tag|Tags]] | Adds tags to pages which allow list pages to be generated. | | [[https://www.dokuwiki.org/plugin:wrap#syntax|Wrap]] | Allows complex page formatting and design such as columns, spoilers, and advanced table functions. | ===== Namespaces ===== Pages and media (ie images, files) in DokuWiki are stored with a colon-deliminated path where each colon is like a directory name. For instance, this page is called ''lcars:contribute''. You can think of this as ''C:\lcars\contribute.html'' if it helps. To accommodate may files and pages, a simple namespace structure has been created: root: lcars: - zaliel_sel - amanda_webber - img: crew: - zaliel_sel.png - amanda_webber.png ranks: - starfleet_captain.png - starfleet_commander.png - uss_brahe: # This is a page and a namespacee - deck_layout - gallery Therefore, when creating a new page, ensure it is in the ''lcars:'' namespace. If you need to store assets which other pages use, place them in the ''lcars:img'' namespace. Otherwise, store the assets directly under the page you're creating (such as ''lcars:uss_brahe:deck_layout''. ===== Templates ===== Copy the contents of one of the following pages into a new page to quickly begin building a new page: {{topic>templates}} ===== Tools ===== * [[https://www.ditl.org/calcstardate-page.php?ListID=Calculators|Stardate calculator]]