User Tools

Site Tools


joneirik:example

Wikistained Project

<Back>

Stuff goes here.


Content Organisation

First of all what sort of information do we want/need ?

The first step is to split that into sub sections or groups to make it easier to work with, some examples to get started with, but will need to be adjusted as we hash out on all the types of info we want in the wiki, and how best to organise it.

  • Setting (Story, Lore, Background, Characters, etc)
  • Gameplay (Controls, Characters, Stats, Shards, Monsters, Bosses)
  • Items (Weapons, Gear, MAterials, Food, Potions, might be put under gameplay)
  • Misc (Various things like: Cameos, Developer info/quotes, Info from the Kickstarter etc)
  • Guides (Might be put under Gameplay, general guides for getting through the game, or a list of ones)
  • Modding (Can be either UE4 general things, or just how general UE4 modding applies to BS)

This should be first priority, so we can start organising data.


Sub-folders

This system is generally easiest to work with and manage, but it requires users to keep track of the folder structure, and remember which folder they are working in. This is the system I use on my own wiki, but I'm an old MS:DOS console user, so I'm used to working with folders. This can also be used for different wiki's like for example Rituals, Curse1, Curse2, Modding etc.

Dividing information into sub groups, in this example:

  • Lore
  • Gameplay
  • Item

Example setup:

/lore/start.txt
/lore/story.txt
/lore/miriam.txt
/lore/zangetsu.txt
/gameplay/start.txt
/gameplay/shards.txt
/gameplay/monsters.txt
/gameplay/bosses.txt
/gameplay/zangetsu.txt
/item/start.txt
/item/materials.txt
/item/use.txt
/item/head.txt
/item/armour.txt
/item/weapon.txt

Different visualisation:

  • /start.txt
  • /lore/
    • start.txt
    • story.txt
    • miriam.txt
    • zangetsu.txt
  • /gameplay/
    • start.txt
    • shards.txt
    • monsters.txt
    • bosses.txt
    • zangetsu.txt
  • /item/
    • start.txt
    • materials.txt
    • use.txt
    • head.txt
    • armour.txt
    • weapon.txt

This makes it easier to work with different types of information and data, and splits things up into more manageable chunks. This also allows us to have “duplicate” files in different sub folders, like above there is a /lore/zangetsu.txt and also a /gameplay/zangetsu.txt, and since they're in different sub folders this is no problem.

If we want to make lots of small pages, for example we want to make separate pages for every single weapon, we can add more sub-folders very easy, example:

/item/weapon/start.txt
/item/weapon/zangetsuto.txt
/item/weapon/dull.txt
/item/weapon/deathbringer3.txt

Prefix names

Another method of doing this is adding a prefix to the filename, this works but tends to get annoying the more files you get to work with. Like if we add a separate page for each material. It feels easier to work with at start, since you don't have to deal with folders, and still keeps things organised. This will end up with one single folder per wiki, with lots of files. And you end up having to write longer filenames when linking.

Example:

  • /start.txt
  • /lore_start.txt
  • /lore_story.txt
  • /lore_miriam.txt
  • /lore_zangetsu.txt
  • /gameplay_start.txt
  • /gameplay_shards.txt
  • /gameplay_monsters.txt
  • /gameplay_bosses.txt
  • /gameplay_zangetsu.txt
  • /item_start.txt
  • /item_materials.txt
  • /item_use.txt
  • /item_head.txt
  • /item_armour.txt
  • /item_weapon.txt

Example:

  • item_weapon_deathbringer.txt
  • item_weapon_deathbringer2.txt
  • item_weapon_deathbringer3.txt
  • item_weapon_sacredsword.txt
  • item_weapon_sacredsword2.txt
  • item_weapon_sacredsword3.txt
  • item_weapon_chargewideend.txt
  • item_weapon_chargewideend2.txt
  • item_weapon_chargewideend3.txt
  • item_weapon_drillwideend.txt
  • item_weapon_drillwideend2.txt
  • item_weapon_drillwideend3.txt
  • item_weapon_petrifactionsword.txt
  • item_weapon_petrifactionsword2.txt
  • item_weapon_petrifactionsword3.txt

Media filenames

Another good thing to think about early, is how to store media files. Example pictures.

For example, if we plan to use the in-game icons for all the items (gear, materials, food etc) on the wiki, and we plan to make a general table to navigate all of the items, that link to its own subpage. Then having the items with the same file-name as the subpage would be beneficial.

Example:

  • /item/food/riceball.txt
  • /media/item/food/riceball.png

This isn't my speciality, I haven't really touched the media section enough myself.


Formatting

General page formatting is pretty simple in DokuWiki, you can write down most of it in a normal text editor like Notepad/Notepad++/Wordpad etc. I can write up a very basic guide if anyone wants, you can also edit any page and on top of the edit field it gives you links to “syntax” and “playground”, the first explains a lot of useful commands, and the other lets you play around and test them without worry.

Once you've gotten used to it, you can just start writing the codes right into the text document as you write things. I usually sit writing out things in NP++ with all the basic formatting like headlines, separation lines, bullet points etc, right into the text. And can just copy/paste it into the wiki afterwards.

Worst case, just poke at me, and I can help out with the editing.

Very basic tips:

  • One of the best tips, keep ALL filenames in lower caps. Saves us for so much annoying stuff down the line.
  • Double line-break between lines, if you only use a single it bunches it up into a single sentence.
  • Use size 4 headlines, as they gives you a own edit button, so you can edit a small section instead of the whole document.
  • Add a back button for easy navigation
  • Stuff like tables looks complicated but is actually very easy to work with if you have a spreadsheet program.
==== Headline Size 4 ====
[[start|back]]

Formatting Example

Just an example to show how I write something, and how it appears:

==== Potions ====
[[start|back]]

Potions are various usable items you have in your inventory,
 and can use in the menu to either heal or remove negative effects.

Try not to drink the poison.

  * Potions
  * High Potions
  * Ex Potions
  * Ether
  * High Ether
  * Ex Ether
  * Mithridate
  * Holy Water
  * Stonethaw
  * Poison
  * Waystone
  * Panacea
  * Faerie Medicine
  * Faerie Elixir
  * Faerie Allheal
  * Faerie Panacea

-----

Potions

back

Potions are various usable items you have in your inventory, and can use in the menu to either heal or remove negative effects.

Try not to drink the poison.

  • Potions
  • High Potions
  • Ex Potions
  • Ether
  • High Ether
  • Ex Ether
  • Mithridate
  • Holy Water
  • Stonethaw
  • Poison
  • Waystone
  • Panacea
  • Faerie Medicine
  • Faerie Elixir
  • Faerie Allheal
  • Faerie Panacea

joneirik/example.txt · Last modified: 2021/07/18 04:37 by 127.0.0.1