porting_existing_tutorials_to_the_wiki
Differences
This shows you the differences between two versions of the page.
Both sides previous revisionPrevious revisionNext revision | Previous revision | ||
porting_existing_tutorials_to_the_wiki [2021/03/12 19:26] – [Translated HTML files] hc9 | porting_existing_tutorials_to_the_wiki [2022/04/26 22:41] (current) – [Here are some tips:] hc9 | ||
---|---|---|---|
Line 6: | Line 6: | ||
===== Translated HTML files ===== | ===== Translated HTML files ===== | ||
- | - User pifty has run a converter on all the existing HTML tutorials and dumped them into the SDF wiki [[https:// | + | - User pifty has run a converter on all the existing |
- | - User peteyboy has run a converter on all the existing HTML tutorials and dumped them into the SDF wiki [[https:// | + | - User peteyboy has run a converter on the existing |
* You can look on the [[start]] or [[SDF basics]] page to find a file to convert (see that it is an external link in the wiki to http:// | * You can look on the [[start]] or [[SDF basics]] page to find a file to convert (see that it is an external link in the wiki to http:// | ||
Line 19: | Line 19: | ||
- | It's better if you do some cleanup: | + | ==== It's better if you do some cleanup: |
* in another new tab, open this link for the dokuwiki [[wiki: | * in another new tab, open this link for the dokuwiki [[wiki: | ||
* make changes, using the preview to make sure the page looks good before saving | * make changes, using the preview to make sure the page looks good before saving | ||
- | Here are some tips: | + | ==== |
* Many of the paragraphs have leading spaces in the converted text, remove them because in wiki that's a code block | * Many of the paragraphs have leading spaces in the converted text, remove them because in wiki that's a code block | ||
* Remove anchor markup in headings, they are probably all messed up. The wiki automatically makes TOCs, so the manual ones can **go** | * Remove anchor markup in headings, they are probably all messed up. The wiki automatically makes TOCs, so the manual ones can **go** | ||
* Remove any manually generated TOCs, because **above** | * Remove any manually generated TOCs, because **above** | ||
+ | * Remove any HTML escape codes, like //> < &// dokuwiki markup doesn' | ||
+ | * Add wiki escape for character strings that are used in wiki markup, for example < | ||
+ | * The protocol in a url is separated from the path by a colon and two slashes, for example: < | ||
+ | http:< | ||
+ | </ | ||
+ | |||
+ | This should render as you expect, meaning not switching italics on for the rest of the document: | ||
+ | |||
+ | The protocol in a url is separated from the path by a colon and two slashes, for example: | ||
+ | http:< | ||
+ | |||
+ | * leading a line by two spaces renders the line as //" | ||
+ | |||
+ | this is code | ||
+ | |||
+ | ==== Reference to HTML tutorial you ported ==== | ||
+ | Currently we are using the following convention to link to the source HTML tutorials, via a snippet at the end of the tutorial that looks like so in dokuwiki markup: | ||
+ | |||
+ | >< | ||
+ | |||
+ | For example, the markup looks like: | ||
+ | <code dokuwiki> | ||
+ | |||
+ | [[http:// | ||
+ | </ | ||
+ | |||
+ | And the Example page would then include: | ||
+ | > | ||
+ | |||
+ | |||
+ | |||
+ | **Notes** | ||
porting_existing_tutorials_to_the_wiki.txt · Last modified: 2022/04/26 22:41 by hc9