[2024-feb-29] Sad news: Eric Layton aka Nocturnal Slacker aka vtel57 passed away on Feb 26th, shortly after hospitalization. He was one of our Wiki's most prominent admins. He will be missed.
Differences
This shows you the differences between two versions of the page.
Both sides previous revisionPrevious revisionNext revision | Previous revisionLast revisionBoth sides next revision | ||
slackdocs:offline_editing [2012/12/25 06:02 (UTC)] – added details about obtaining existing pages mfillpot | slackdocs:offline_editing [2013/03/16 00:02 (UTC)] – updated for slackdoctool v 0.1.2 mfillpot | ||
---|---|---|---|
Line 1: | Line 1: | ||
+ | <!-- 0.1.2 --> | ||
====== Offline Wiki Editing ====== | ====== Offline Wiki Editing ====== | ||
Line 13: | Line 14: | ||
The most basic way to start working on a new article offline is to open your | The most basic way to start working on a new article offline is to open your | ||
favorite text editor and start writing. However, when pasting the contents | favorite text editor and start writing. However, when pasting the contents | ||
- | of your article into the wiki you will need to paste the data inside of the | + | of your article into the wiki you will need to paste the data inside of the |
template. | template. | ||
Line 26: | Line 27: | ||
built-in function to ease the trouble. | built-in function to ease the trouble. | ||
- | When in a webbrowser looking at the page you will need to append the synatax | + | When in a webbrowser looking at the page you will need to append the syntax |
**< | **< | ||
[[http:// | [[http:// | ||
Line 49: | Line 50: | ||
This repository is located at | This repository is located at | ||
- | [[https:// | + | [[https:// |
- | You can download single files from the github | + | If you wish to build a package |
- | repository by issuing the following command in the terminal while logged in | + | associated slackbuild script set at [[https:// |
- | as a non-root user. | + | |
- | < | + | The script has many functions that can be reviewed by issuing the **-l** |
- | user@darkstar$ git clone git:// | + | argument or viewing the man file. |
- | </code> | + | |
Once the template files are downloaded you can open the appropriate template | Once the template files are downloaded you can open the appropriate template | ||
Line 62: | Line 62: | ||
your content. | your content. | ||
- | The file **syntax.docuwiki** | + | The file **syntax.docuwiki** |
- | brief examples of the dokuwiki syntax that is used by the Slackware | + | will give you brief examples of the dokuwiki syntax that is used by the Slackware |
Documentation Project. | Documentation Project. | ||
< | < | ||
To simplify editing the docuwiki formatted articles, instructions to enable | To simplify editing the docuwiki formatted articles, instructions to enable | ||
- | syntax highlighting in various editors is included in this article. | + | syntax highlighting in various editors is included in the slackdoctool.. |
The extension **.slackdoc** is used for the templates to automatically enable | The extension **.slackdoc** is used for the templates to automatically enable | ||
Line 86: | Line 86: | ||
==== vim Syntax Highlighting ==== | ==== vim Syntax Highlighting ==== | ||
- | To simplify editing in the **vim** text editor the git repo listed above | + | To simplify editing in the **vim** text editor the slackdoctool can download |
- | contains a vim syntax file that will enable syntax highlighting for all | + | and load the necessary configuration |
- | syntax that is used by the Slackware Documentation Project wiki. | + | |
- | + | ||
- | The file // | + | |
- | contains all necessary | + | |
- | + | ||
- | === Installing the vim Syntax File === | + | |
- | To ease installation of the syntax file, the script named // | + | |
- | is included in the syntax_file directory of the git repo. This script, when | + | |
- | launched from that directory, does the following: | + | |
- | - Removes all lines that contain the word slackdocs from your // | + | |
- | - Adds the following lines to the end of the // | + | |
- | < | + | |
- | " Add a pointer to the $FILETYPE vim syntax file | + | |
- | au BufRead, | + | |
- | au! Syntax slackdocs source {repo_directory}/ | + | |
- | </ | + | |
- | This process removes any old configuration | + | |
- | updates it with the current configuration. | + | |
- | + | ||
- | You can alternatively add it to the standard syntax file location and turn | + | |
- | the syntax on automatically, | + | |
- | + | ||
- | < | + | |
- | If updates are made to the repo based syntax file you can update the repo by | + | |
- | issuing the command | + | |
- | the // | + | |
- | </ | + | |
==== kate Syntax Highlighting ==== | ==== kate Syntax Highlighting ==== | ||
Line 138: | Line 111: | ||
from [[http:// | from [[http:// | ||
- | Issue the command < | + | Issue the command < |
Then the complete document is in your clipboard, you can then paste it into | Then the complete document is in your clipboard, you can then paste it into | ||
the wiki's WYSIWYG editor. | the wiki's WYSIWYG editor. | ||
+ | |||
+ | Alternatively, | ||
+ | with the **-c** argument. | ||
====== Sources ====== | ====== Sources ====== |