[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.

Welcome to the Slackware Documentation Project

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
slackdocs:offline_editing [2013/01/02 09:41 (UTC)] – [Obtaining Existing Wiki Pages] typo sycamorexslackdocs:offline_editing [2013/03/18 13:24 (UTC)] (current) – [Offline Editing] fixed typo sycamorex
Line 1: Line 1:
-<!-- 0.0.2 -->+<!-- 0.1.2 -->
 ====== Offline Wiki Editing ====== ====== Offline Wiki Editing ======
  
Line 14: 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 50: Line 50:
  
 This repository is located at This repository is located at
-[[https://github.com/mfillpot/slackdoc_templates]].+[[https://github.com/mfillpot/slackdoctool]]
  
-You can download single files from the github site or clone the complete +If you wish to build a package from the github repo you can find an 
-repository by issuing the following command in the terminal while logged in +associated slackbuild script set at [[https://github.com/mfillpot/mfillpot_SlackBuild_Scripts/tree/sdt/office/slackdoctool]] 
-as a non-root user. + 
-<code> +The script has many functions that can be reviewed by issuing the **-l** 
-user@darkstar$ git clone git://github.com/mfillpot/slackdoc_templates.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 63: Line 62:
 your content. your content.
  
-The file **syntax.docuwiki** is included with the git repo files to give +The file **syntax.docuwiki** can be downloaded with the **-S** argument, it 
-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.
  
 <note> <note>
 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 87: 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 files with the option **-s vim**.
-syntax that is used by the Slackware Documentation Project wiki. +
- +
-The file //slackdocs.vim// that is contained in the syntax_files directory +
-contains all necessary syntax highlighting criteria for the wiki documents. +
- +
-=== Installing the vim Syntax File === +
-To ease installation of the syntax file, the script named //add_vim_file.sh// +
-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 //~/.vimrc// file. +
-  - Adds the following lines to the end of the //~/.vimrc// file: +
-  <file> +
-  " Add a pointer to the $FILETYPE vim syntax file +
-  au BufRead,BufNewFile *.slackdoc set filetype=slackdocs +
-  au! Syntax slackdocs source {repo_directory}/syntax_files/slackdocs.vim +
-  </file> +
-This process removes any old configuration for the .slackdoc extension and +
-updates it with the current configuration. +
- +
-You can alternatively add it to the standard syntax file location and turn +
-the syntax on automatically, but the automatic option is more user friendly. +
- +
-<note> +
-If updates are made to the repo based syntax file you can update the repo by +
-issuing the command **"git pull"** from within the repo directory and re-run +
-the //add_vim_file.sh// to update your //~/.vimrc// file. +
-</note>+
  
 ==== kate Syntax Highlighting ==== ==== kate Syntax Highlighting ====
Line 143: Line 115:
 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, the slackdoctool can load the documents into the clipboard
 +with the **-c** argument.
  
 ====== Sources ====== ====== Sources ======
 slackdocs:offline_editing ()