From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: from mp0 ([2001:41d0:2:4a6f::]) (using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits)) by ms0.migadu.com with LMTPS id 2agMEAHFqGH1eQEAgWs5BA (envelope-from ) for ; Thu, 02 Dec 2021 14:07:13 +0100 Received: from aspmx1.migadu.com ([2001:41d0:2:4a6f::]) (using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits)) by mp0 with LMTPS id KFUVCQHFqGH7HAAA1q6Kng (envelope-from ) for ; Thu, 02 Dec 2021 13:07:13 +0000 Received: from lists.gnu.org (lists.gnu.org [209.51.188.17]) (using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits)) (No client certificate requested) by aspmx1.migadu.com (Postfix) with ESMTPS id 1461D6716 for ; Thu, 2 Dec 2021 14:07:12 +0100 (CET) Received: from localhost ([::1]:39784 helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1mslnr-0000HP-76 for larch@yhetil.org; Thu, 02 Dec 2021 08:07:11 -0500 Received: from eggs.gnu.org ([209.51.188.92]:47904) by lists.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1mslmQ-0000Ff-Rz for emacs-orgmode@gnu.org; Thu, 02 Dec 2021 08:05:43 -0500 Received: from mail51.lwspanel.com ([193.203.239.34]:56298) by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_128_CBC_SHA1:128) (Exim 4.90_1) (envelope-from ) id 1mslmD-0002BW-Eq for emacs-orgmode@gnu.org; Thu, 02 Dec 2021 08:05:42 -0500 Received: from mail51.lwspanel.com (localhost.localdomain [127.0.0.1]) by filter2.mynetwork.local (Postfix) with ESMTP id AC49A451754 for ; Thu, 2 Dec 2021 14:05:17 +0100 (CET) X-MAILING-TO: emacs-orgmode@gnu.org DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/simple; d=presentiel.fr; s=dkim; t=1638450310; bh=qGSZaf6djcgiSjkXJShZzMWPdtVFq499OsDlJZ6YaIw=; h=Subject:References:To:Cc:From:Date:In-Reply-To; b=tJNxbiIDOIDTqpBjuJ7J6gEvGg6zbTfUnh0bBSO3vqBisZdKOm0sgVSDTUlzesyem ZfirgJjuomhi4wV+EpWJYFY4MZaJwrV7qkN45F+zIKqnSzUW8r6jcgG1AHuZXk0Gas YIvDyfdcZeiPK2mHseD4SKkMA64+LH0U/BcoR4tg= X-MAILING-TO: brownexitus@protonmail.com X-Envelope-From: Received: from [192.168.0.137] (82-65-166-34.subs.proxad.net [82.65.166.34]) (Authenticated sender: emacs-orgmode@presentiel.fr) by mail51.lwspanel.com (Postfix) with ESMTPSA id 6ACD2451945; Thu, 2 Dec 2021 14:05:09 +0100 (CET) Subject: Re: examples for org-manual References: <069952f0-fff2-cbbb-1a4b-37a3ca480dd1@presentiel.fr> To: brownexitus From: Vincent Breton X-Forwarded-Message-Id: <069952f0-fff2-cbbb-1a4b-37a3ca480dd1@presentiel.fr> Message-ID: <04cc406a-03e8-6bde-b67d-e3cac239daa3@presentiel.fr> Date: Thu, 2 Dec 2021 14:05:08 +0100 User-Agent: Mozilla/5.0 (X11; Linux x86_64; rv:78.0) Gecko/20100101 Thunderbird/78.7.0 MIME-Version: 1.0 In-Reply-To: <069952f0-fff2-cbbb-1a4b-37a3ca480dd1@presentiel.fr> Content-Type: text/plain; charset=utf-8 Content-Transfer-Encoding: 8bit Content-Language: fr Received-SPF: pass client-ip=193.203.239.34; envelope-from=emacs-orgmode@presentiel.fr; helo=mail51.lwspanel.com X-Spam_score_int: -53 X-Spam_score: -5.4 X-Spam_bar: ----- X-Spam_report: (-5.4 / 5.0 requ) BAYES_00=-1.9, DKIM_SIGNED=0.1, DKIM_VALID=-0.1, DKIM_VALID_AU=-0.1, DKIM_VALID_EF=-0.1, NICE_REPLY_A=-3.3, SPF_HELO_NONE=0.001, SPF_PASS=-0.001 autolearn=ham autolearn_force=no X-Spam_action: no action X-BeenThere: emacs-orgmode@gnu.org X-Mailman-Version: 2.1.29 Precedence: list List-Id: "General discussions about Org-mode." List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Cc: emacs-orgmode@gnu.org Errors-To: emacs-orgmode-bounces+larch=yhetil.org@gnu.org Sender: "Emacs-orgmode" X-Migadu-Flow: FLOW_IN X-Migadu-Country: US ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=yhetil.org; s=key1; t=1638450432; h=from:from:sender:sender:reply-to:subject:subject:date:date: message-id:message-id:to:to:cc:cc:mime-version:mime-version: content-type:content-type: content-transfer-encoding:content-transfer-encoding: in-reply-to:in-reply-to:references:references:list-id:list-help: list-unsubscribe:list-subscribe:list-post:dkim-signature; bh=qGSZaf6djcgiSjkXJShZzMWPdtVFq499OsDlJZ6YaIw=; b=EPNJ6ACbSGI2tQFFkBgmHERwAuPBETXr3/VxNwsOnsz4aGJIH0nvjtJfndMyC/7qVBNqhB uBaTICsDIllJruNDS16+O7wkOiCHS32l+g6+uJFp2qW86CHE796oTYQJi4RvEQNpv8yhFJ W9Z0f3FLqv1AtsbBC2HmqKBf9TjyycjI/kes6zDZfeHB66tLQdTZZPBdslyfN48xMGTNuA t9Lok8715If/ILcu16ZwlQSSldC0FlBxFOhlqoyhQwMqIQolWKqZKd2zqGiw0da7Cv/HCk L0jFDlv83tLkxw6QNjMLcKGV8/hjS+ZVb3meGBdKdfTZKw9paeI6mD8qh+f71Q== ARC-Seal: i=1; s=key1; d=yhetil.org; t=1638450432; a=rsa-sha256; cv=none; b=mjywufFM6hDsyAz0A1kaJAzo1+9owdf0P37mywTuHUb0U5WYN+J1Un5C7Esh4F9T0/6SGV ThubN5q88wObot4JJoBuf1IzudHWvBCH7j1WXmWfZvqRmF4xDDRjJg6N2oaWi2Z4HIgp+m AUlKw41rOgNbw3J9Qgt2b4VzsI7IaHoMx+4LgcrOqM5xM+wTGOqJZF3imiSfyV6Y3k/5Ob rLo6Mr4a3IRV4VOzmTSJyVZMZMH1Bt5BU2T9/DJEU021Bdn/GjAWD7ujPVbFt2FYv4aFF6 HWKSXwuameXyhSCQix0JyvbFze3ufdBOiMvTmtcAxxKN1chV7BFX+elx55ZNGQ== ARC-Authentication-Results: i=1; aspmx1.migadu.com; dkim=pass header.d=presentiel.fr header.s=dkim header.b=tJNxbiID; dmarc=none; spf=pass (aspmx1.migadu.com: domain of "emacs-orgmode-bounces+larch=yhetil.org@gnu.org" designates 209.51.188.17 as permitted sender) smtp.mailfrom="emacs-orgmode-bounces+larch=yhetil.org@gnu.org" X-Migadu-Spam-Score: -3.62 Authentication-Results: aspmx1.migadu.com; dkim=pass header.d=presentiel.fr header.s=dkim header.b=tJNxbiID; dmarc=none; spf=pass (aspmx1.migadu.com: domain of "emacs-orgmode-bounces+larch=yhetil.org@gnu.org" designates 209.51.188.17 as permitted sender) smtp.mailfrom="emacs-orgmode-bounces+larch=yhetil.org@gnu.org" X-Migadu-Queue-Id: 1461D6716 X-Spam-Score: -3.62 X-Migadu-Scanner: scn0.migadu.com X-TUID: MZqoyw6KXBb2 Hi, Emacs and Emacs Org documentation, and lot of others GNU products use Texinfo to generate their own  documentation to different formats. Unlucky, they are just the HTML version on https://www.gnu.org/software/emacs/manual/org.html and It is not for lack of having written the 22 november 2021 a message about org documentation... on this list. I remember you can access to a PDF version of Org I published on http://www.presentiel.com/org/org.pdf. and another one more short: http://www.presentiel.com/org/orgguide.pdf. In my opinion, the trouble with just  a Wiki is not the most appropriate for printed version and in a Wiki or others CMS, some pages are short and others long without page number so it's more difficult to appreciate the length of the document and the time to study it. They are also others troubles with Web pages about security or about private life when you explore a web site... That why I encourage to publish documentation with different formats, more particularly when the doc is written for Texinfo tool who make all the work easily. In my experience, the best thing to do is to start to write a draft using plain text. If you prefer, you can also use directly a CMS to generate HTML: only HTML where it's easy to copy and past text but please in all cases  use a very simple CSS if you use it. In my opinion,that is a good idea to use a common tool as git to publish and update your work but don't forget to inform. If your content is good and clear, it will be interesting to upgrade it to a beautiful book: that's another work very hard for some people and very simple for others: generally the last one use (La)TeX years after years. I'm sure, some people will play the game with accepting to send and publish for free interesting examples for Org. On this forum, I'm sure you will find too lot of tips and tricks. In my opininon the big difference between a manual and a book about Gnu products are layout, illustrations and copyrights. I hope to read soon your first writings  about some Org examples before I provide you a PDF version made with LaTeX and without change of text. Best regards On 02/12/2021 03:58, brownexitus wrote: > Hi Vincent, t > > I hear what you say, but isn't more efficient to have something like the emacs wiki etc? or even links to other sites that explain it that way? > > If the manual is available somewhere on git (I'm new to this whole thing), perhaps I can try to offer changes that will go in there. I don't know that that's possible though. > > creating a PDF and contributing to it like that is similar to writing a book, which is not a bad idea in itself, but it's not going to lift off the ground as easy as just contributing to the manual...? What do you think. > >> Hi, >> >> In my opinion, lot of manuals don't have enough examples. >> >> One way to solve this would be to create a list of examples in another >> >> document with references to the org documentation in PDF format (page >> >> numbers, relevant sections...). This would not change anything in the >> >> original documentation and would make it easier to understand or to >> >> identify possible obscure and incomplete aspects. >> >> Once the list of examples is sufficiently complete and validated, it >> >> could be attached to the original documentation with for example at >> >> least a paragraph and a link to consult this compilation of examples >> >> playing the role of a large appendix, or even links to the examples >> >> document in the text for the most interesting examples. >> >> It's a big job but if enough people would contribute according to their >> >> possibilities and time, we would have much more than a simple book of >> >> examples. >> >> I hope it will be useful. >> >> On 01/12/2021 05:09, brownexitus via General discussions about Org-mode. >> >> wrote: >> >>> The org-manual could use more practical examples, in my opinion. >>> >>> How does one submit suggestions/edits? >