Hacktoberfest 2026: le issue che i maintainer hanno segnato per ottobre, aperte e adatte ai principianti. Sfoglia le issue Hacktoberfest

Automatically download PHP documentation?

Aperta
#288 0 commenti 2 reazioni 0 assegnatari Vedi su GitHub

Nessuno ha ancora preso questa issue.

Valutazione

Difficoltà
5/5
Tempo stimato
Più di una settimana
Idoneità per principianti
25/100
Tipo di issue
Funzionalità
Chiarezza
Da chiarire
Stato di attività
Ferma
Stack tecnologico
emacs-lisp, php
Ambito
documentation, tooling

Direzione di ricerca

Inizia con l’esempio Emacs Lisp dell’issue ed esamina la ricerca della documentazione esistente in php-mode, inclusi php-manual-path e l’integrazione con il browser eww. Definisci la configurazione e il comportamento di download necessari per la documentazione PHP locale, quindi verifica che il manuale possa essere trovato o scaricato in modo affidabile.

Scritto dal modello di indicizzazione a partire dal testo della issue.

Descrizione

I'm just dropping this in here as food for thought. The following is the code I wrote to ensure that all of my dev environments will have access to local PHP docs inside Emacs via the eww browser, without me needed to fetch them manually.

It would be pretty nice if one could configure php-mode to do something similar.

;; Find documentation (locally or online).
(define-key php-mode-map (kbd "<f1>") 'php-search-documentation)
(when (fboundp 'eww-browse-url)
  (setq php-search-documentation-browser-function 'eww-browse-url))

;; Locate local documentation.
(let ((expected "/usr/local/share/php/php-chunked-xhtml"))
  (if (file-directory-p expected)
      (setq php-manual-path expected)
    (setq expected (expand-file-name "~/php/php-chunked-xhtml"))
    (if (file-directory-p expected)
        (setq php-manual-path expected)
      (message "PHP manual not found. Attempting download.")
      ;; Download and untar
      (let ((download-directory (file-name-directory expected))
            (url "http://php.net/get/php_manual_en.tar.gz/from/this/mirror")
            (file "php_manual_en.tar.gz"))
        (make-directory download-directory t)
        (shell-command
         (apply 'format
                "cd %s && wget -q %s -O %s && tar -xf %s && rm %s"
                (mapcar 'shell-quote-argument
                        (list download-directory url file file file)))))
      ;; Check the result
      (if (file-directory-p expected)
          (setq php-manual-path expected)
        (message "Failed to download PHP manual.")))))
Lingua principale
Emacs Lisp
Stelle
602
Fork
117
Merge medio
12h 54m
PR unite (30g)
3

Guida per i contributori

Apri la guida per i contributori

Come iniziare

  1. Leggi tutta la issue e poi la guida ai contributi del progetto.
  2. Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
  3. Fai un fork del repository e lavora su un branch.
  4. Apri una pull request che faccia riferimento al numero della issue.

Altre issue di emacs-php/php-mode

Tutte le issue di emacs-php/php-mode

Issue simili

Altre issue su Documentation

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.