User Tools

Site Tools


about_the_class:style_guide

This is an old revision of the document!


A PCRE internal error occured. This might be caused by a faulty plugin

====== Style Guide for Wiki ====== DokuWiki Syntax: https://banana-slug.soe.ucsc.edu/wiki:syntax As an introduction, Andreas Gohr has a couple of short DokuWiki video tutorials at, [[http://www.splitbrain.org/blog/2008-10/05-dokuwiki_beginners_screencast_01|DokuWiki Beginners Screencast #1 and #2]]. --- //[[jlong@soe.ucsc.edu|Jeff Long]] Tue Mar 30 13:45:05 PDT 2010// ====== In Progress ====== We need to decide on and implement an official format for citations; using footnotes is "totally lame". Any suggestions? --- //[[learithe@soe.ucsc.edu|Jenny Draper]] 2010/03/30// I can install various plugins for citation formatting: [[http://www.dokuwiki.org/plugins?plugintag=references]]. What do people think would work best? --- //[[karplus@soe.ucsc.edu|Kevin Karplus]] 2010/03/30 15:40// [[http://www.dokuwiki.org/plugin:refnotes|refnotes]] seems the most promising option. There's also [[http://www.dokuwiki.org/plugin:cite|cite]], but its description is very vague. Too bad the [[http://www.dokuwiki.org/plugin:bibtex|bibtex]] one has a reported and unpatched major vulnerabilty. --- //[[learithe@soe.ucsc.edu|Jenny Draper]] 2010/03/30 16:04//

Discussion

, 2010/04/02 23:48

refnotes has been installed. Check it out and see how well it works. Chris, you might want to provide a short “how to cite” section and a pointer to the refnotes documentation.

, 2010/04/03 08:15

The RefNotes plugin seems to work well. However, when I try to set the extra line that is generated in the references section used to separate note blocks from the rest of the article

<refnotes>notes-separator: none</refnotes>

I get PHP warnings. Could you look into changing the level of PHP warnings displayed in use on the server where the wiki is installed, or possibly change the “Notes block separator” option on the admin page for the RefNotes plugin (if it indeed an option there for it) to “None”?

, 2010/04/03 19:31

I enabled php inclusion for the wiki, and I changed the refnotes reference formatting to use brackets instead of superscripts.

, 2010/04/04 01:18

It seems that the PHP warnings appear in the preview before submitting an edit, but disappear after the edit is saved, so the problem is no longer an issue.

, 2010/04/02 22:06

In Progress

We need to decide on and implement an official format for citations; using footnotes is “totally lame”. Any suggestions? — Jenny Draper 2010/03/30

I can install various plugins for citation formatting: http://www.dokuwiki.org/plugins?plugintag=references. What do people think would work best? — Kevin Karplus 2010/03/30 15:40

refnotes seems the most promising option. There's also cite, but its description is very vague. Too bad the bibtex one has a reported and unpatched major vulnerabilty. — Jenny Draper 2010/03/30 16:04

It looks like the refnotes plugin should be sufficient for assisting in formatting the citations needed for the wiki. The cite plugin allows easy citation of pages on the wiki that the plugin is installed on and as such probably would not help with citation formatting.

Also, I have found the imagereference plugin that allows MediaWiki style (e.g. Wikipedia) captions for images; this would be significantly better than just using alt text for captions. What style should we use for the citing references on the wiki? — Christopher Brumbaugh 2010/04/02 08:04

You could leave a comment if you were logged in.
about_the_class/style_guide.1269990862.txt.gz · Last modified: 2010/03/30 23:14 by learithe