Differences

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

--- porting_existing_tutorials_to_the_wiki [2021/03/13 02:18] – [Translated HTML files] added line about HTML escape codes peteyboy
+++ porting_existing_tutorials_to_the_wiki [2022/04/26 22:41] (current) – [Here are some tips:] hc9
@@ Line 6: / Line 6: @@
 ===== Translated HTML files =====
-  - User pifty has run a converter on all the existing ([[wp>Revision_Control_System|RCS]]) HTML tutorials, and dumped them into the SDF wiki [[https://git.sdf.org/pifty/tutes-dump/src/branch/master/dump|here, at git.sdf.org]]
+  - User pifty has run a converter on all the existing ([[wp>Revision_Control_System|RCS]]) HTML tutorials, and dumped them into the SDF git instance [[https://git.sdf.org/pifty/tutes-dump/src/branch/master/dump|here, at git.sdf.org]]
-  - User peteyboy has run a converter on the existing ([[wp>Revision_Control_System|RCS]]) HTML tutorials, //cleaned-up((2021/03/11 23:56 start -- pointed to forked tutes-dump with more 'cleaned up' html2docuwiki dumps peteyboy...[[https://wiki.sdf.org/doku.php?id=start&do=revisions|Old Revisions]]))// files, and dumped them into the SDF wiki [[https://git.sdf.org/peteyboy/tutes-dump/src/branch/master/dump|here, at git.sdf.org]]
+  - User peteyboy has run a converter on the existing ([[wp>Revision_Control_System|RCS]]) HTML tutorials, //cleaned-up((2021/03/11 23:56 start -- pointed to forked tutes-dump with more 'cleaned up' html2docuwiki dumps peteyboy...[[https://wiki.sdf.org/doku.php?id=start&do=revisions|Old Revisions]]))// files, and dumped them into the SDF git instance [[https://git.sdf.org/peteyboy/tutes-dump/src/branch/master/dump|here, at git.sdf.org]]
   * 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://sdf.org/?tutorials/)
@@ 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]]
   * 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
   * 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 HTML escape codes, like //&gt; &lt; &amp;// 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", 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:
+  * Add wiki escape for character strings that are used in wiki markup, for example <nowiki>// or [[ or {{, or whole URLs you don't want to be links</nowiki> (<nowiki>//</nowiki>, for example, is the Dokuwiki markup for //italics//). To escape, surround the text in the editor with <nowiki><nowiki> and </nowiki></nowiki> tags, HTML-style, like so:
+    * The protocol in a url is separated from the path by a colon and two slashes, for example: <code>
+http:<nowiki>//</nowiki>sdf.org
+</code>
+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:<nowiki>//</nowiki>sdf.org
+  * leading a line by two spaces renders the line as //"code"((Additional [[wiki:syntax#code_blocks|Code Blocks]] are mentioned in the DokuWiki [[wiki: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
-=== Notes ===
+====  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**