Browse Source

Major edit.

Bastien Guerry 11 years ago
parent
commit
d37dda82ee
8 changed files with 98 additions and 1277 deletions
  1. 32 24
      index.org
  2. 0 1160
      survey.org
  3. 19 25
      worg-about.org
  4. 9 0
      worg-editing.org
  5. 0 14
      worg-faq.org
  6. 36 32
      worg-git.org
  7. 2 2
      worg-todo.org
  8. 0 20
      worg-tutorials.org

+ 32 - 24
index.org

@@ -9,43 +9,51 @@
 #+CATEGORY:   worg
 #+OPTIONS:    H:3 num:nil toc:t \n:nil @:t ::t |:t ^:t -:t f:t *:t TeX:t LaTeX:t skip:nil d:(HIDE) tags:not-in-toc
 
-Let say that you like [[http://www.gnu.org/software/emacs/][Emacs]] and that you like using [[http://orgmode.org][org-mode]] for editing
-structured files in Emacs.  Then you might want to /share/ some =.org=
-files and ask people to edit them with you.  This is what *Worg* is
-[[file:worg-about.org][about]]: collaboratively editing Org files to build a knowledge database
-about =.org= itself (and planning-related stuff.)
+[[http://www.gnu.org/software/emacs/][Emacs]] is a text editor.  [[http://orgmode.org][Org-mode]] is an Emacs tool written by Carsten
+Dominik which helps you organize your life with plain text files.  =Worg=
+is a set of Org files collectively edited by people who like Org-mode and
+want to share tutorials, ideas, code snippets, etc.
 
-* Pages about Worg 
+# For this dynamic block to work, you need to add elisp/worg.el in your
+# load-path.
 
-- [[file:worg-about.org][About the Worg project]]
-- [[file:worg-todo.org][The Worg TODO file]]
-- [[file:worg-git.org][How to use git for Worg?]]
-- [[file:worg-git-ssh-key.org][How to create your own SSH key for repo.or.cz?]]
-- [[file:worg-editing.org][How to edit Worg pages?]]
-- [[file:worg-tutorials.org][Worg tutorials]]
-- [[file:faq.org][The Worg FAQ]]
+#+BEGIN: timestamp :string "Last update: " :format "%Y-%m-%d @ %H:%M"
+Last update: 2008-02-07 @ 20:33
+#+END:
 
-* Pages about Org
+# Let say that you like [[http://www.gnu.org/software/emacs/][Emacs]] and that you like using [[http://orgmode.org][org-mode]] for editing
+# structured files in Emacs.  Then you might want to /share/ some =.org=
+# files and ask people to edit them with you.  This is what *Worg* is [[file:worg-about.org][about]]:
+# collaboratively editing Org files to build a knowledge database about
+# =.org= itself (and planning-related stuff.)
 
-[[http://orgmode.org/][Org-mode]] is a fantastic extension to [[http://www.gnu.org/software/emacs/][GNU Emacs]] written by [[http://www.astro.uva.nl/~dominik][Carsten
-Dominik]].  It's a powerful, versatile, addictive *organizer* and
-*outliner*.
+* Pages about Org
 
-- [[file:survey.org][Org survey results]]
 - [[file:org-tutorials/index.org][Org Tutorials]]
-- [[file:org-configs/index.org][Org Configs]]
-- [[file:org-testimonies/index.org][Your life in Org]]
-- [[file:org-screenshots.org][Screenshots]]
-- [[file:org-faq.org][Org FAQ]]
+- [[file:org-configs/index.org][Org configuration examples]]
+- [[file:org-testimonies/index.org][People describe how they use Org]]
+- [[file:org-screenshots.org][Screenshots of Org in action]]
+- [[file:org-faq.org][The Org-mode FAQ]]
 
+#- [[file:org-survey.org][Org survey results]]
 #- [[file:org-code/index.org][Org add-ons]]
+ 
+* Pages about Worg
 
-* Pages about planning and GTD
+- [[file:worg-about.org][About the Worg project]]
+- [[file:worg-git.org][A introduction to git for Worgers]]
+- [[file:worg-editing.org][Conventions and tools for editing Worg]]
+- [[file:worg-todo.org][The Worg TODO file]]
+- [[file:worg-git-ssh-key.org][How to create your own SSH key for repo.or.cz?]]
 
-- [[file:planning/readings.org][Readings]]
+#* Pages about planning and GTD
+#
+#- [[file:planning/readings.org][Readings]]
 
 * Search in Org mailing list
 
+The Org mailing list is very active.  
+
 #+BEGIN_HTML
 <form method="get" action="http://search.gmane.org/">
 <input type="text" name="query">

File diff suppressed because it is too large
+ 0 - 1160
survey.org


+ 19 - 25
worg-about.org

@@ -11,37 +11,28 @@
 
 [[file:index.org][{Back to Worg's index}]]
 
-This is the about page of Worg.  Worg is =Web-Org=: a website
-collectively edited using [[http://www.orgmode.org][Org]] (in Emacs) and maintained as a [[http://git.or.cz][git]]
-repository.
+* What is Org?  What is Worg?
 
-* What is Org?  Worg?
+[[http://www.orgmode.org][Org]] is an [[http://www.gnu.org/software/emacs/][Emacs]] mode for /keeping notes, maintaining to-do lists, and doing
+project planning with a fast and effective plain-text system./ (as the [[http://www.orgmode.org/org.html][Org
+manual]] says.)
 
-[[http://www.orgmode.org][Org]] is an [[http://www.gnu.org/software/emacs/][Emacs]] mode for /keeping notes, maintaining to-do lists, and
-doing project planning with a fast and effective plain-text system./ (as
-the [[http://www.orgmode.org/org.html][Org manual]] says.)
+Worg is an attempt to /collectively/ built a knowledge database about [[http://orgmode.org][Org]],
+planning in plain text and other related topics.
 
-Worg is an attempt to /collectively/ built a knowledge database about
-[[http://orgmode.org][Org]], planning in plain text and other related topics.
-
-* Why using Worg?
+* Why using Org-mode for creating a collaborative website?
 
 Because Org makes it easy, fast and effective to edit *well-structured*
-files.  Ever wanted to edit a [[file:org-tutorials/tables.org][table]] in a wiki?  Ever wanted to change
-the sectioning structure in a wikipage?  Ever wanted to edit lists
-quickly?  Now you can.
+files.  Ever wanted to edit a [[file:org-tutorials/tables.org][table]] in a wiki?  Ever wanted to change the
+outline structure in a wikipage?  Ever wanted to edit lists quickly?  Org
+lets you do this.
 
 Because Org-mode makes *beautiful* documents : it support links, font
-beautification, examples, etc.  Anything you can really expect from a
-text editing tool.
-
-Because Org is also a powerful *task-management system*.  Hopefully
-sharing a [[file:worg-todo.org][TODO file]] will make it easy for everyone to know where he
-could help.
+beautification, examples, etc.  And you can export those documents to HTML
+or LaTeX.
 
-Because Org files can be exported to various formats (HTML, LaTeX).
-Ever wanted to write LaTeX documents with people not knowing LaTeX?
-Now you can.
+Because Org is also a powerful *task-management system*.  Hopefully sharing
+a [[file:worg-todo.org][TODO file]] will make it easy for everyone to know where he could help.
 
 * So it's a bit like a wiki, no?
 
@@ -83,8 +74,11 @@ bite into this and start sharing tutorials, example of codes, etc.
 * Ok, I want to start now!
 
 The first thing you need to know is [[file:worg-git.org][how to use git for Worg]].  The second
-thing you might be interested in are general advices and conventions on
-how to [[file:worg-editing.org][let Worg grow]].
+thing you might be interested in are general advices and conventions on how
+to [[file:worg-editing.org][let Worg grow]].
+
+
+
 
 
 

+ 9 - 0
worg-editing.org

@@ -11,6 +11,9 @@
 
 [[file:index.org][{Back to Worg's index}]]
 
+Since Worg is just starting now, these conventions are just suggestions,
+not recommendations.  Please improve this.
+
 * Conventions
 
 ** To-do keywords
@@ -50,6 +53,12 @@ You can find a default header here: [[file:worg-header.org][worg-header.org]]
 Just create it.  Before committing changes in Worg, make sure you add
 the file to the repository index with =git add *.org=
 
+* What about dynamic blocks
+
+If you are using dynamic blocks in Worg, please don't forget to add the
+relevant code in the =elisp/worg.el= file.  See for example the dynamic
+block for the timestamp in the [[file:index.org][index]] page.
+
 * COMMENT How do I rename a file?
 * COMMENT Can I create a directory?
 * COMMENT What about non-org files in the repository?

+ 0 - 14
worg-faq.org

@@ -1,14 +0,0 @@
-#+OPTIONS:    H:3 num:nil toc:t \n:nil @:t ::t |:t ^:t -:t f:t *:t TeX:t LaTeX:t skip:nil d:(HIDE) tags:not-in-toc
-#+STARTUP:    align fold nodlcheck hidestars oddeven lognotestate
-#+SEQ_TODO:   TODO(t) INPROGRESS(i) WAITING(w@) | DONE(d) CANCELED(c@)
-#+TAGS:       Write(w) Update(u) Fix(f) Check(c) 
-#+TITLE:      Worg: Frequently Asked Questions
-#+AUTHOR:     Worg people
-#+EMAIL:      bzg AT altern DOT org
-#+LANGUAGE:   en
-#+PRIORITIES: A C B
-#+CATEGORY:   worg
-
-[[file:index.org][{Back to Worg's index}]]
-
-Do we need a FAQ for Worg?

+ 36 - 32
worg-git.org

@@ -13,41 +13,33 @@
 
 * What is git?
 
-[[http://git.or.cz][git]] is a fast version control system that let you collaborate on a
-project.  For details on how using git, go and read the [[http://www.kernel.org/pub/software/scm/git/docs/tutorial.html][git tutorial]].
-For details on the public git repository, go and read the [[http://repo.or.cz/about.html][about page]] of
+[[http://git.or.cz][git]] is a fast version control system that let you collaborate on a project.
+For details on how using git, go and read the [[http://www.kernel.org/pub/software/scm/git/docs/tutorial.html][git tutorial]].  For details on
+the public git repository, go and read the [[http://repo.or.cz/about.html][about page]] of
 http://repo.or.cz/.
 
-The Worg repository page is here: http://repo.or.cz/w/Worg.git
+The homepage of the Worg project is here: http://repo.or.cz/w/Worg.git
 
 * The first time you contribute to Worg
 
-1. Register a new account on the git public repository (where worg
-   lives): http://repo.or.cz/m/reguser.cgi -- see the tutorial on how to
-   [[file:worg-git-ssh-key.org][create a SSH-key for repo.or.cz]].
+1. If you don't have a SSH-key, [[file:worg-git-ssh-key.org][create one]].
 
-2. Drop me an email ([[mailto:bzg%20AT%20altern%20DOT%20org][bzg AT altern DOT org]]) and ask me to be listed as
-   an Org contributor, telling me your username on the git repository;
+2. Register a [[http://repo.or.cz/m/reguser.cgi][new account]] on the git public repository.
 
-3. Install git on your system.
+3. Drop an email to [[mailto:bzg%20AT%20altern%20DOT%20org][Bastien]] mentionning your username on repo.or.cz
 
-4. Clone the project somewhere in a working directory:
+4. Install git on your system.
 
-# FIXME: Should it be git clone git+ssh://repo.or.cz/srv/git/Worg.git ?
-#                                  ^^^^
+5. Clone the project somewhere in a working directory:
 
-   :~$ git clone http://repo.or.cz/r/Worg.git
+   :~$ git clone git+ssh://repo.or.cz/srv/git/Worg.git ?
 
-5. Go to the newly created =Worg/= directory and edit the files
+6. Go to the newly created =Worg/= directory and edit some files.
 
-6. Add new files to the index:
+7. If you created files, add them to the git index:
 
    :~$ git add *.org
 
-7. Get a diff a the change you've just made:
-
-   :~$ git diff --cached
-
 8. Commit changes with the appropriate ChangeLog:
 
   :~$ git commit -a -m "My changelog"
@@ -56,25 +48,36 @@ The Worg repository page is here: http://repo.or.cz/w/Worg.git
 
   :~$ git push
 
-* Editing Worg from an existing working directory
-
-1. Update your Worg directory:
+* The second time you contribute to Worg
 
-   :~$ git pull
+1. Go to your =Worg/= directory.
 
-   Note: this is the equivalent of =cvs update= and will complain if
-   there are conflicts between your working directory and the remote
-   Worg directory.
+2. Be sure to "pull" the last version of the repository.
 
-2. Edit the files
+3. Make some changes.
 
-3. Add new files (=git-add=) and commit your changes (=git-commit=)
+4. Commit your changes on your local repository: 
+   
+   :~$ git commit -a -m "My ChangeLog"
 
-4. Push your Worg directory
+5. Push your change on the remote repository
 
    :~$ git push
 
-You're done!
+* Getting organized
+
+The Worg TODO file is =worg-todo.org=.  If you are a Worg zealot, maybe you
+want to add this file to the list of your agenda files.  For example, here
+is my =org-agenda-files= variable:
+
+  :(setq org-agenda-files '("~/org/bzg.org" "~/git/Worg/worg-todo.org")
+
+I have an agenda custom command for checking tasks that are assigned to me:
+
+  :(org-add-agenda-custom-command '("W" tags "Owner=\"Bastien\""))
+
+The next time someone assigns a task for me, it will appear in my Worg
+agenda view.  
 
 * Register your changes under your name
 
@@ -89,7 +92,8 @@ Edit it like this:
 
 Now your changes will be filed under your name.
 
-* Anonymous editing through the "mob" user/branch
+# I'm not sure this is useful at all:
+* COMMENT Anonymous editing through the "mob" user/branch
 
 If you don't want to register a new account on =repo.or.gz= but still
 want to suggest modifications on Worg, you can do this by editing the

+ 2 - 2
worg-todo.org

@@ -22,9 +22,9 @@ agenda view will be populated with Worg-related tasks.
 
 * Write tutorials
   :PROPERTIES:
-  :Owner_ALL: bzg dto clemente aspiers rustom
+  :Owner_ALL: bzg dominik dto clemente aspiers rustom phil bretfeld wacko hexmode pete
   :END:
-
+  
 ** TODO List other possible tutorials from [[http://orgmode.org/tutorials.html][Carsten's tutorials page]] 
 ** Gather examples of custom agenda views from the mailing list
 ** Tutorial about the LaTeX exporter

+ 0 - 20
worg-tutorials.org

@@ -1,20 +0,0 @@
-#+OPTIONS:    H:3 num:nil toc:t \n:nil @:t ::t |:t ^:t -:t f:t *:t TeX:t LaTeX:t skip:nil d:(HIDE) tags:not-in-toc
-#+STARTUP:    align fold nodlcheck hidestars oddeven lognotestate
-#+SEQ_TODO:   TODO(t) INPROGRESS(i) WAITING(w@) | DONE(d) CANCELED(c@)
-#+TAGS:       Write(w) Update(u) Fix(f) Check(c) 
-#+TITLE:      Worg tutorials
-#+AUTHOR:     Worg people
-#+EMAIL:      bzg AT altern DOT org
-#+LANGUAGE:   en
-#+PRIORITIES: A C B
-#+CATEGORY:   worg
-
-[[file:index.org][{Back to Worg's index}]]
-
-* Tutorials about Worg
-
-- [[file:worg-editing.org][Editing Worg]]
-
-- [[file:worg-git-ssh-key.org][Creating a SSH-key and registering in repo.or.cz]] to be able to upload
-  to Worg
-