From mboxrd@z Thu Jan 1 00:00:00 1970 Path: news.gmane.io!.POSTED.blaine.gmane.org!not-for-mail From: Joost Kremers Newsgroups: gmane.emacs.help Subject: Re: pdf-tools documentation Date: Sat, 19 Jun 2021 22:50:32 +0200 Message-ID: <87wnqp35b8.fsf@fastmail.fm> References: Mime-Version: 1.0 Content-Type: text/plain Injection-Info: ciao.gmane.io; posting-host="blaine.gmane.org:116.202.254.214"; logging-data="5431"; mail-complaints-to="usenet@ciao.gmane.io" User-Agent: mu4e 1.5.12; emacs 27.2.50 Cc: help-gnu-emacs@gnu.org To: Julius Hamilton Original-X-From: help-gnu-emacs-bounces+geh-help-gnu-emacs=m.gmane-mx.org@gnu.org Sat Jun 19 23:37:21 2021 Return-path: Envelope-to: geh-help-gnu-emacs@m.gmane-mx.org Original-Received: from lists.gnu.org ([209.51.188.17]) by ciao.gmane.io with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.92) (envelope-from ) id 1luieW-0001Dv-QG for geh-help-gnu-emacs@m.gmane-mx.org; Sat, 19 Jun 2021 23:37:21 +0200 Original-Received: from localhost ([::1]:46194 helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1luieV-0000aU-SK for geh-help-gnu-emacs@m.gmane-mx.org; Sat, 19 Jun 2021 17:37:19 -0400 Original-Received: from eggs.gnu.org ([2001:470:142:3::10]:54844) by lists.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1luidw-0000Yz-SP for help-gnu-emacs@gnu.org; Sat, 19 Jun 2021 17:36:45 -0400 Original-Received: from wout3-smtp.messagingengine.com ([64.147.123.19]:53857) by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1luidp-0005eA-7O for help-gnu-emacs@gnu.org; Sat, 19 Jun 2021 17:36:41 -0400 Original-Received: from compute4.internal (compute4.nyi.internal [10.202.2.44]) by mailout.west.internal (Postfix) with ESMTP id 3B1DE1531; Sat, 19 Jun 2021 17:36:34 -0400 (EDT) Original-Received: from mailfrontend2 ([10.202.2.163]) by compute4.internal (MEProxy); Sat, 19 Jun 2021 17:36:34 -0400 DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=fastmail.fm; h= references:from:to:cc:subject:date:in-reply-to:message-id :mime-version:content-type; s=fm3; bh=5bPuJUu1fM4dzdJXqvdlR+fpwo DsgrO3zINuSckCWmg=; b=IgYm34Ql0VpazMphZ5Q+pS8NKZNwJ+yq6nUhXKA5vy NM/qOm2hQlxUno3nKnOVM3yqbBP4mfCjuvBnBJfr8BjH1KAxot3d+4EyKFaH2B/3 LcxbQSJYbXOYswvxPXuP7H/d8RFeYyUL5Vpqkq8+R0lrBPzDFu8nRj5VlZuPiI7i CTeDmX4WonQPYhK7e8x2ZBlVSfVWe1FZ/GCKjuIGlONtjjbX9h2sMldki1An2ixc HJz5+g6glhq9z58hSZdma2tS+xP/O8nmlJcNWUVAm7GZtWtyp7XtGnQ0XqVYcvSU IeTDnhaFnhsMdxqkNT05V6wmDbHkRhZbzMZny4o8PhIw== DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d= messagingengine.com; h=cc:content-type:date:from:in-reply-to :message-id:mime-version:references:subject:to:x-me-proxy :x-me-proxy:x-me-sender:x-me-sender:x-sasl-enc; s=fm3; bh=5bPuJU u1fM4dzdJXqvdlR+fpwoDsgrO3zINuSckCWmg=; b=iTBh0LyatmnjUGMqBkIZmy 7Szq+Sm9/Mn3ND+AJMbEALOxosg3XBZH0t9PT8E1h9DHakZDDzWFTqCe2xoL7i+s OTfECW8QpMTyP5tI9fMtkilE2DVXbneHyctLLM8h4fIpNUHh+Hji4lGaiBxvmSRQ Hc4oL3WhVKRFekRNOGAmXvpo7WI16IrKZ/1aQZoSoxQHxZTCB1xpP1x1hvuvJgAR 9ekkR6KSnT35F4aR45CcOVF4TkWDPNMytCGpqqTKyoSUPfLXyV+8/wnEGQkK4wiu dRh0p0Elirk7auS2aJlGlAbybOHmds4TxX18bh9C/RXDCv6+GBEfaOPLvs5jwPZA == X-ME-Sender: X-ME-Received: X-ME-Proxy-Cause: gggruggvucftvghtrhhoucdtuddrgeduledrfeefiedgvddvucetufdoteggodetrfdotf fvucfrrhhofhhilhgvmecuhfgrshhtofgrihhlpdfqfgfvpdfurfetoffkrfgpnffqhgen uceurghilhhouhhtmecufedttdenucesvcftvggtihhpihgvnhhtshculddquddttddmne cujfgurhepfhgfhffvufffjgfkgggtsehttdertddtredtnecuhfhrohhmpeflohhoshht ucfmrhgvmhgvrhhsuceojhhoohhsthhkrhgvmhgvrhhssehfrghsthhmrghilhdrfhhmqe enucggtffrrghtthgvrhhnpefgffekveeivdeffeevjeeuffegjeekudegteeuleeigfeg vefgkeehvedukefghfenucffohhmrghinhepghhithhhuhgsrdgtohhmpdhmvghlphgrrd horhhgnecuvehluhhsthgvrhfuihiivgeptdenucfrrghrrghmpehmrghilhhfrhhomhep jhhoohhsthhkrhgvmhgvrhhssehfrghsthhmrghilhdrfhhm X-ME-Proxy: Original-Received: by mail.messagingengine.com (Postfix) with ESMTPA; Sat, 19 Jun 2021 17:36:33 -0400 (EDT) In-reply-to: Received-SPF: pass client-ip=64.147.123.19; envelope-from=joostkremers@fastmail.fm; helo=wout3-smtp.messagingengine.com X-Spam_score_int: -27 X-Spam_score: -2.8 X-Spam_bar: -- X-Spam_report: (-2.8 / 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_LOW=-0.7, SPF_HELO_PASS=-0.001, SPF_PASS=-0.001 autolearn=ham autolearn_force=no X-Spam_action: no action X-BeenThere: help-gnu-emacs@gnu.org X-Mailman-Version: 2.1.23 Precedence: list List-Id: Users list for the GNU Emacs text editor List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: help-gnu-emacs-bounces+geh-help-gnu-emacs=m.gmane-mx.org@gnu.org Original-Sender: "help-gnu-emacs" Xref: news.gmane.io gmane.emacs.help:131051 Archived-At: On Sat, Jun 19 2021, Julius Hamilton wrote: > I noticed on its official page, https://github.com/politza/pdf-tools, it Note that pdf-tools was recently taken over by another maintainer. If you go to melpa.org, search for the package and then go to its home page, you'll notice it's now maintained at . > has a lot of instructions about installation, and a list of some commands, > but there's no link to any complete documentation which includes all > features. > > How can I learn about its features in detail? > > Should I use some kind of Emacs help command about the library? There is, unfortunately, not one single method of documenting Emacs packages. There's a few things you can try, though. `C-h P` (`describe-package`) asks for a package name and shows you the description that is provided in the package's source code. Some packages have a lot of info there, some very little. Other packages provide an info manual: `C-h i` takes you to the main info node, there you can check if your package has an info manual. In the case of pdf-tools, `C-h P` gives you the same info that is present in Github, and there is no info manual, so neither method will help you... The next thing to do is then to see what key bindings are present. If you do `C-h m` (`describe-mode`) you'll get a description of the minor modes and the major mode in the current buffer. There is usually a lot of irrelevant information there, so you'll need to search a bit for what you are looking for. The major mode is discussed first, though, and there is a list of keybindings. The overview of keybindings only shows the commands that the keys execute, but often the names are fairly self-explanatory, and clicking on a command usually shows you a description. If you have a completion package that shows you a list of candidates (I use selectrum myself, but there are several other options), typing `M-x pdf-tools` will give you a list of commands that have `pdf-tools` in their name, which can also be a good way to look for something specific. Sometimes, the menu-bar menu can be helpful as well. If you've disabled the menu bar, you can still access the menu with F10. Other useful things to know: `C-h c` lets you type a key and tells you which command is bound to it. More useful perhaps is `C-h k`, which lets you type a key and displays the documentation of the command that's bound to it. In the end, the quality of the documentation really depends on the package author, however... -- Joost Kremers Life has its moments