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 ms11 with LMTPS id yOKzAACUVGDOeAAA0tVLHw (envelope-from ) for ; Fri, 19 Mar 2021 12:07:28 +0000 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 AEExOP+TVGDxVgAA1q6Kng (envelope-from ) for ; Fri, 19 Mar 2021 12:07:27 +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 CBF4818F88 for ; Fri, 19 Mar 2021 13:07:26 +0100 (CET) Received: from localhost ([::1]:43836 helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1lNDuX-0002Dw-Fv for larch@yhetil.org; Fri, 19 Mar 2021 08:07:25 -0400 Received: from eggs.gnu.org ([2001:470:142:3::10]:43354) by lists.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1lNDtO-000218-2B for emacs-orgmode@gnu.org; Fri, 19 Mar 2021 08:06:14 -0400 Received: from mail-pg1-x535.google.com ([2607:f8b0:4864:20::535]:40456) by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_128_GCM_SHA256:128) (Exim 4.90_1) (envelope-from ) id 1lNDtM-0007Gy-Bp for emacs-orgmode@gnu.org; Fri, 19 Mar 2021 08:06:13 -0400 Received: by mail-pg1-x535.google.com with SMTP id v186so3532831pgv.7 for ; Fri, 19 Mar 2021 05:06:11 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20161025; h=from:to:subject:date:user-agent:message-id:mime-version; bh=QMOs2yH1WgdPe8Bw3G0XH4NkcZyMKbSkJWAfrFHm4v4=; b=ZED5JIjNzkXVNB+fPpptJsV7r73tvpogZ+fg4nXAZPHPJK5d44wByMRYuxDEy7R9HD xyBj1YFNtQd8imm7jLCtJP6aFETcxiZvIHXu2n5xpR2Fn8VbKFwIA/AoAo4HXSBW6D3+ Xp/qC5hmOBCUWoh3RkKjQpJJY/x4BvFf3CI/99IZPcW9REjj6Pm21y14AJjo/kGQUvUp i0q6c15ifw7MqY9YKtbWiU5uhnZkTuoC83FWqY0ygF/1Llx9z2SXc08hOlPOG8P76z+T GuQzd2W9zbsf0ik/LQwpBdYCbK6pHoUwXvEkzndicGt95rggRaft5vfq9XFw7gDzjk5l W9ZA== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20161025; h=x-gm-message-state:from:to:subject:date:user-agent:message-id :mime-version; bh=QMOs2yH1WgdPe8Bw3G0XH4NkcZyMKbSkJWAfrFHm4v4=; b=piMECYku4GHA5pB5Q/fA9iH4FCatb+k9taO3EICuxW94V+uWZjZYCeWWNsZHAaLd0G MiPfX6ObyM0bAPaflZYyTryFPMNlPuZ+VKl+CIRsNy2Vt7oGsZNHC7dxesfYzY3iSehE f4fAs5Q0eHVf4cefvZMdD6XjhCQwvS51mvQujlMnVO9KBSbgHVdNR21ihV0Upjqq/tiU lpjZJ1aOMaug1s6pCXz37Yod40PYTUFnkZ8InLxNyj9bnVs17xOt4fZVk7W2CPcjNmbX 9L5IoQTaL7RcswhkAEtoLwxODNvjoof0UnJcKK+Vrhh3llzlX2Y214wlliT6oYcj5Qaa +Wyw== X-Gm-Message-State: AOAM530upu3bne1F+IpttCeZe8J3kUYha2xW6z/PYtid76V1phf7Zrb0 xGw2lUWSHXoVTCJ8wNtFs6ZtWxGAi0s= X-Google-Smtp-Source: ABdhPJwTIgwrXVnRNgxoTYiVZKaap07xHewp0z4cHmwimZRREvPUtjPPlC09fpWjGyfhWw52DYRYzQ== X-Received: by 2002:a63:c74b:: with SMTP id v11mr11013871pgg.336.1616155570551; Fri, 19 Mar 2021 05:06:10 -0700 (PDT) Received: from localhost (180-150-91-8.b4965b.per.nbn.aussiebb.net. [180.150.91.8]) by smtp.gmail.com with ESMTPSA id f20sm5561076pfa.10.2021.03.19.05.06.09 for (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Fri, 19 Mar 2021 05:06:10 -0700 (PDT) From: Timothy To: org-mode-email Subject: [PATCH] Improve documentation of #+startup keyword Date: Fri, 19 Mar 2021 20:03:09 +0800 User-agent: mu4e 1.4.15; emacs 28.0.50 Message-ID: <874kh72vrl.fsf@gmail.com> MIME-Version: 1.0 Content-Type: multipart/mixed; boundary="=-=-=" Received-SPF: pass client-ip=2607:f8b0:4864:20::535; envelope-from=tecosaur@gmail.com; helo=mail-pg1-x535.google.com X-Spam_score_int: -20 X-Spam_score: -2.1 X-Spam_bar: -- X-Spam_report: (-2.1 / 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, FREEMAIL_FROM=0.001, RCVD_IN_DNSWL_NONE=-0.0001, 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.23 Precedence: list List-Id: "General discussions about Org-mode." List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: emacs-orgmode-bounces+larch=yhetil.org@gnu.org Sender: "Emacs-orgmode" X-Migadu-Flow: FLOW_IN ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=yhetil.org; s=key1; t=1616155647; h=from:from:sender:sender:reply-to:subject:subject:date:date: message-id:message-id:to:to:cc:mime-version:mime-version: content-type:content-type:list-id:list-help:list-unsubscribe: list-subscribe:list-post:dkim-signature; bh=QMOs2yH1WgdPe8Bw3G0XH4NkcZyMKbSkJWAfrFHm4v4=; b=K2K1T61B3vsgAWbyx0mA7BQ+QqL+5TbkAnZ1vUzeTCtxTZsyCjJbIRpBKLwF3m6OR6SvGn fXZYZ54Z6TwKL0uucRDZurCl55A3Gr9wuCFsemHFvfYRJi5IfMT96hYPMzT7nnKXip2yjb Kwg+2RBZAoW0CfSFegPrwLZFfcwJptsHtHsGjDb1wxC6P+iV8NCjxEeSfsRTI737AkzJH0 xyHhySuNlJOSDpjguwvN5je9NWPhFAa+o+cqOrEteHofASkOPSUjaWVLpDXMimOCbqoobN KyYuAmRdXIZji8LQr02jGDrEXqmwHsohR/zjlzVsZg0jCXY73+A3GM7E8XmgOg== ARC-Seal: i=1; s=key1; d=yhetil.org; t=1616155647; a=rsa-sha256; cv=none; b=fJx8VOzinDhdc+p8H4Y2we1KVB3jVBCKheFY3qrR97DxjmNabrYgxEBNeM7XsunbIdgAmd dVbc+JbWRMy7q44mcbL7JB+Dw6RLSfjluYGUfHLynlmWGsUL0lNGo4z7GS7olWcDsF+Oiy dhd3G+Y+cjJNdBVnnZIUsDYaE4hkKLScmtnFzXcAmYpOiLwLX3u87OSIxVosU/SY73hdhL m9+isyAxgSPw3WYy+zYQw+K3uXzjYmoqVQbITxDDPCi/Ny5RkRVKel8hCiIz8u0rAbt6zB eE4H4RFB8+ax91IuB1g4L3H/IYXGCt/0cTN2jbeOE3o2Yc3I8OZ5dIkTslRGew== ARC-Authentication-Results: i=1; aspmx1.migadu.com; dkim=pass header.d=gmail.com header.s=20161025 header.b=ZED5JIjN; dmarc=pass (policy=none) header.from=gmail.com; spf=pass (aspmx1.migadu.com: domain of emacs-orgmode-bounces@gnu.org designates 209.51.188.17 as permitted sender) smtp.mailfrom=emacs-orgmode-bounces@gnu.org X-Migadu-Spam-Score: -3.11 Authentication-Results: aspmx1.migadu.com; dkim=pass header.d=gmail.com header.s=20161025 header.b=ZED5JIjN; dmarc=pass (policy=none) header.from=gmail.com; spf=pass (aspmx1.migadu.com: domain of emacs-orgmode-bounces@gnu.org designates 209.51.188.17 as permitted sender) smtp.mailfrom=emacs-orgmode-bounces@gnu.org X-Migadu-Queue-Id: CBF4818F88 X-Spam-Score: -3.11 X-Migadu-Scanner: scn0.migadu.com X-TUID: uGd/Ewds4j7B --=-=-= Content-Type: text/plain Content-Disposition: inline Hello all, I was talking to someone who was finding the behaviour of `#+startup' confusing, and they managed to work out a table summarising the behaviour. I think that this would be a good addition to the manual, and help clarify the behaviour --- so I've prepared a little patch to the manual. I notice that there are some `#+cindex' lines lying around but I'm not quite sure what they do. Please let me know if I should add anything like that etc. All the best, *Timothy* --=-=-= Content-Type: text/x-patch Content-Disposition: attachment; filename=0001-doc-org-manual.org-clarify-startup-behaviour.patch >From 8ff32dfbf2e14419eb542d58ee39c1545f34354b Mon Sep 17 00:00:00 2001 From: TEC Date: Fri, 19 Mar 2021 20:01:03 +0800 Subject: [PATCH] doc/org-manual.org: clarify #+startup behaviour * doc/org-manual.org: clarify the behaviour that each #+startup option implies. --- doc/org-manual.org | 13 +++++++++++++ 1 file changed, 13 insertions(+) diff --git a/doc/org-manual.org b/doc/org-manual.org index e8763ff17..a005cce52 100644 --- a/doc/org-manual.org +++ b/doc/org-manual.org @@ -598,6 +598,19 @@ *** Initial visibility is requested by startup options and =VISIBILITY= properties in individual entries. +A summary of each keyword's behaviour may be seen in the table below. +| #+startup: | org-startup-folded | VISIBILITY | shows headings | shows body | +|---------------------+--------------------+------------+----------------+------------| +| overview (or fold) | t | x | lvl1 | | +| content | 'content | x | all | | +| show2levels | 'show2levels | x | lvl1-2 | | +| ... | 'showNlevels | x | lvl1-N | | +| show5levels | 'show5levels | x | lvl1-5 | | +| showall (or nofold) | nil | x | all | x | +| showeverything | 'showeverything | | all | x | +| | 'showeverything | | all | x | + + *** Catching invisible edits :PROPERTIES: :DESCRIPTION: Preventing mistakes when editing invisible parts. -- 2.30.1 --=-=-=--