User Tools

Site Tools


porting_existing_tutorials_to_the_wiki

Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Both sides previous revisionPrevious revision
Next revision
Previous revision
Next revisionBoth sides next revision
porting_existing_tutorials_to_the_wiki [2021/03/12 22:24] – [Translated HTML files] hc9porting_existing_tutorials_to_the_wiki [2021/03/15 23:33] – Added the 'traditional link' convention we're currently using, along with sample markup snippet peteyboy
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:syntax]]   * in another new tab, open this link for the dokuwiki [[wiki:syntax]]
   * 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:+====  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't need these escaped, and doesn't render them as expected by HTML.
 +  * leading a line by two spaces renders the line as //"code"((Additional [[doku>syntax#code_blocks|Code Blocks]] are mentioned in the DokuWiki [[doku>syntax#formatting_syntax|Formatting Syntax]] section.))//, so you can replace delineation around code that is meant for user to type, such as quotes or some other markup, with two spaces, like so:
 +
 +  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:
 +
 +><Link to Tutorial> - traditional link (using <Wikipedia link to 'RCS' definition>)
 +
 +For example, the markup looks like:
 +<code dokuwiki>
 +
 +[[http://sdf.org/?tutorials/Ruby_on_Rails | Ruby on Rails]] - traditional link (using [[wp>Revision_Control_System|RCS]])
 +</code>
 +
 +And the Example page would then include:
 +>[[http://sdf.org/?tutorials/Ruby_on_Rails | Ruby on Rails]] - traditional link (using [[wp>Revision_Control_System|RCS]])
 +
 +
  
-=== Notes ===+**Notes**
  
porting_existing_tutorials_to_the_wiki.txt · Last modified: 2022/04/26 22:41 by hc9