Both sides previous revisionPrevious revisionNext revision | Previous revisionLast revisionBoth sides next revision |
porting_existing_tutorials_to_the_wiki [2021/03/15 19:39] – [Here are some tips:] hc9 | porting_existing_tutorials_to_the_wiki [2022/04/26 22:03] – [Here are some tips:] hc9 |
---|
===== Translated HTML files ===== | ===== 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/) | * 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/) |
* 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. | * 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: | * 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 | 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** |
| |