====== Working in a WIKI ====== In the first part of our course, we will guide you through the essential steps of **documenting your work** in a [[doku>dokuwiki|DokuWiki]]. You will do this by generating a nice and appealing CV, where you make extensive use of the features the DokuWiki offers you. For this purpose, we have set up a //studentarea// where you are free to create and edit pages, upload data((Note, some file types are considered security risks, and you are not allowed to upload them. For example, plain text files will not work. Any image format, however, is fine)), and the like. This student area is distinct from the rest of the course wiki, such that you cannot do any harm while experimenting with the DokuWiki. ===== What is a Dokuwiki ===== If you are not familiar with the concepts of a DokuWiki, please [[general:computerenvironment:wiki|visit our introductory pages]] first ===== Task list ===== As a first set of exercises, please complete the following steps. Note, you will find a guide through the DokuWiki syntax further down this page. - Create your own page in the student area, if it not already exists. Use the first letter of your first name together with your full last name (without white spaces) as the page name, e.g., //iebersberger//. Note, within the student area access the namespace that fits the course you are attending: - [[:studentarea:mbw|MscMolBio]] - [[pbioc_basics:studentarea|MScPbioC]] - [[ecoevo_molevol:studentarea|MScEcoEvo]] After visiting the namespace page, you can generate your own page in the following way: - Decide on the name of your page. Note, the page name must not contain any white spaces and should be informative, so your name or your user name would be a good option. For the example we will use the page name //Ingo Ebersberger//, and we assume that the page should be created in the [ecoevo_molevol:studentarea|EcoEvo namespace]] - Switch to the edit mode - Add your page name to list together with an internal link to your page. See below for the DokuWiki code - [[ecoevo_molevol:studentarea:2025:iebersberger|Ingo Ebersberger]] - Now, please create an extra page within __your__ namespace that takes up your CV. From this point on, you will place all newly generated pages into your personal namespace, such that you keep the studentarea clean. To create a page in your own namespace, just adhere to the following syntax to create the link to the new page [[ecoevo_molevol:studentarea:2021:ingoebersberger:cv|CV]] Note, you can add further sub-namespaces just as you wish, e.g. for your data, papers, etc. - Create a CV that informs in particular about((The information will only be visible to the course members and will be deleted at the end of the course)) - your scientific career - your research interests - your professional skills providing details about your digital competencies Make sure to have this profile page as informative and appealing as possible. In other words, make rich use of the [[general:computerenvironment:wiki:page|formatting options]] provided by the DokuWiki, and upload images where applicable((This exercise is mainly about getting to know the features of a DokuWiki, such that you are ready to use them once you start with documenting your project)). BEFORE YOU START WITH IMPLEMENTING YOUR WEB PAGE, DO THE FOLLOWING: * Take a piece of paper and draft the layout of your CV using a pen * specify the formatting options that you need the DokuWiki to provide you with. BE PRECISE HERE!! * check which of the desired options are available via DokuWiki -> Discuss * if the option is not available, adjust your layout until the issue is resolved * else implement your CV in the DokuWiki * use links to point to your previous research institution * provide the abstract of your Bachelor thesis together with one or two illustrative figures, if you have them at hand * use bulleted lists to organize your skills * use reasonable headings to structure your profile. Note, you can also use horizontal lines by typing four or more dashes * otherwise, just be creative... - We have set the permissions such that you can edit any page that is generated in the student area. Visit the page of your neighbor, modify it and save it. - Once your wiki page has been 'hacked', do the following - Identify the person who has changed your page - use the Old Revisions button in the side menu (Figure {{ref>OldRev}}) to restore your version.
{{:general:images:computerenvironment:oldrevisions.png?600 |}} Upon a click on the 'reverse time' icon, an overview of the old versions of your page appears. To return to an old revision, i.e. to undo changes, click on the desired version, which will then open. Click the edit button and then save. This will make this page the most up to date version.
===== Check List ==== You should be now familiar with the following formatting options together with the relevant syntax * structure your pages with headings * integrate images with the ''
'' environment((Of course you will have to replace ''NameOfFigure'' with the name you want to give your figure. This name is used for internal referencing only)) * integrate tables with the ''
'' environment((Of course you will have to replace ''NameOfTable'' with the name you want to give your Table. This name is used for internal referencing only)) * add figure and table captions using the '''' environment within the ''
'' environment. Note, this will automatically take care of the numbering of figures and tables * reference figures and tables in the main text using the ''%%{%%{ref>NameOfFigure%%}%%}'' syntax * create numbered and bulleted lists * create hidden text using the '''' environment * format text (bold face, underlined, italics) * create internal and external links * create new pages * use the media browser * use of the //old revisions// function to restore previous versions, i.e. to undo changes * and... did you know about the [[https://www.dokuwiki.org/plugin:wrap|wrap plugin]]? If not, check it out. You can do many cool things with it ===== What you should take home ===== Upon completion of this task set, you are able to document your work with the help of a DokuWiki((There are other types of WIKIs aroung, e.g. a MediaWiki. The concept is the same, but the syntax can differ)). In particular, you should be able to * structure and format text using headings, lists, tables, etc. * create new pages * create internal and external links * integrate images You could also think about [[https://www.dokuwiki.org/de:install|installing a DokuWiki]] on your own computer. It is not that difficult... ---- * [[pbioc_basics:start|PBioC main]] * [[pbioc_basics:workplan|PBioC workplan]] * [[mbw_bioinf:mastermbw|MolBio main]] * [[mbw_bioinf:mastermbw:2022:workpackages|MolBio workplan]] * [[ecoevo_molevol:course_introduction|EcoEvo main]] * [[ecoevo_molevol:mee:workplan|EcoEvo workplan]]