More consistent HCFILES filenames (#1776)

.gitignore

@@ -14,7 +14,10 @@ maiko/
 # because they will get regenerated when you rebuild.
 # MEDLEY-UTILS HCFILES regenerates
 
-*.pdf
+# do not ignore .pdf files after all... rather, [new workflow](scripts/make-gh-pages.md) stores it in the src repository gh-pages branch.
+
+# *.pdf
+# index.html
 
 
 # all loadup files 

internal/MEDLEY-UTILS

@@ -1,10 +1,12 @@
 (DEFINE-FILE-INFO PACKAGE "INTERLISP" READTABLE "INTERLISP" BASE 10)
 
-
(FILECREATED "29-Apr-2024 16:25:20" {DSK}<home>larry>il>medley>internal>MEDLEY-UTILS.;9
 28903  
+
(FILECREATED "30-Jun-2024 08:28:44" {DSK}<Users>larry>il>medley>internal>MEDLEY-UTILS.;2
 28720  
 
       :EDIT-BY "lmm"
 
-      :PREVIOUS-DATE "26-Apr-2024 16:34:08" {DSK}<home>larry>il>medley>internal>MEDLEY-UTILS.;8)
+      :CHANGES-TO (FNS HCFILES)
+
+      :PREVIOUS-DATE "29-Apr-2024 16:25:20" {DSK}<Users>larry>il>medley>internal>MEDLEY-UTILS.;1)
 
 
 (PRETTYCOMPRINT MEDLEY-UTILSCOMS)
@@ -258,7 +260,8 @@
 (DEFINEQ
 
 (HCFILES

-  [LAMBDA (BASE REDO SUBSETS)
                                (* ; "Edited 23-Apr-2024 23:15 by lmm")


+  [LAMBDA (BASE REDO SUBSETS)
                                (* ; "Edited 30-Jun-2024 08:27 by lmm")


+                                                             (* ; "Edited 23-Apr-2024 23:15 by lmm")


                                                              (* ; "Edited 22-Apr-2024 13:22 by lmm")


                                                              (* ; "Edited  5-Feb-2024 12:16 by lmm")


                                                              (* ; "Edited  4-Nov-2023 11:14 by lmm")


@@ -302,12 +305,7 @@
                (* ;; 
 
               " doesnt (yet) implement  / to - translattion. .readme should show up as -.readme.")

 
-                     (SETQ DEST (PACKFILENAME 'EXTENSION 'pdf 'NAME
-                                       (IF
 EXT
-                                           THEN
 (LISTGET SRC 'NAME)
-                                         ELSE
 (PACK* (LISTGET SRC 'NAME)
-                                                     '-src))
-                                       'BODY NOV))
+                     (SETQ DEST (CONCAT NOV ".pdf"))
                      (CL:WHEN (AND (NOT REDO)
                                    (INFILEP DEST))
                          (CL:FORMAT T "~a already there~%%" DEST)
@@ -502,9 +500,9 @@
 (ADDTOVAR LAMA
 )
 )
 (DECLARE%: DONTCOPY
-  (FILEMAP (NIL (1064 11630 (GATHER-INFO 1074 . 6456) (MAKE-FULLER-DB 6458 . 7235) (MAKE-INDEX-HTMLS 
-7237 . 10999) (MEDLEY-FIX-LINKS 11001 . 11394) (MEDLEY-FIX-DATES 11396 . 11628)) (12809 15597 (
-MAKE-EXPORTS-ALL 12819 . 13878) (MAKE-WHEREIS-HASH 13880 . 15069) (MAKE-WHEREIS-LOOPS 15071 . 15595)) 
-(15598 23855 (HCFILES 15608 . 20089) (MAKE-INDEX-HTMLS 20091 . 23853)) (24105 28717 (RECOMPILE-ONE 
-24115 . 26012) (RECMPL 26014 . 26617) (COMPILE-SETUP 26619 . 27243) (REMAKEFILES 27245 . 28715)))))
+  (FILEMAP (NIL (1099 11665 (GATHER-INFO 1109 . 6491) (MAKE-FULLER-DB 6493 . 7270) (MAKE-INDEX-HTMLS 
+7272 . 11034) (MEDLEY-FIX-LINKS 11036 . 11429) (MEDLEY-FIX-DATES 11431 . 11663)) (12844 15632 (
+MAKE-EXPORTS-ALL 12854 . 13913) (MAKE-WHEREIS-HASH 13915 . 15104) (MAKE-WHEREIS-LOOPS 15106 . 15630)) 
+(15633 23672 (HCFILES 15643 . 19906) (MAKE-INDEX-HTMLS 19908 . 23670)) (23922 28534 (RECOMPILE-ONE 
+23932 . 25829) (RECMPL 25831 . 26434) (COMPILE-SETUP 26436 . 27060) (REMAKEFILES 27062 . 28532)))))
 STOP

scripts/make-gh-pages.md

@@ -3,71 +3,65 @@ HCFILES writes in {MEDLEYDIR} but it should write in something like (SRCDIR)
 
 # setup
 
- github pages are maintained in the 'src' repository as a forked repo
- If you don't have a clone of src: 
-```
-   gh repo clone interlisp/src # make one
-   cd src                      # all other commands 
-```
-the first time once you've cloned, point the 'src' clone 
-```
-   gh remote add upstream https://github.com/interlisp/medley
+## Remove extraneous files
 
-```
-now update src repository to match 'medley'
-Run these in the 'src' repository!
+There are lots of ways to get there but basically set up the execution environment with everything clean but notecards loops, test are copied in. If you don't make fresh, at least 'git clean'.
 
 ```
-   git fetch upstream                # pull down remote branches
-   git checkout master               # make sure you're in master
-   git rebase upstream/master        # update src's master
-                                      # to latest medley's master
-   git push -f origin master          # push back go sfc
-```
+gh repo clone interlisp/medley
+gh repo clone interlisp/notecards
+gh repo clone interlisp/loops
+gh repo clone interlisp/test
 
-# Run Medly to create PDFs.
-
-Start with the apps sysout to spare yourself package problems
-In an Interlisp exec:
-```
-  (FILESLOAD PDFSTREAM GITFNS MEDLEY-UTILS)
-  (HCFILES)
-  (MAKE-INDEX-HTMLS)
+cp -r notecards loops test medley
+rm -rf notecards/.git loops/.git test/.git
 ```
-check out that it looks right if you point your browser the index/index.hrml at the top level
-
-# deploying
 
-* find the current release tags
-Not sure how to do that.
+# making the .pdfs and index.html files
 
+## best start with a fresh loadup
 ```
-   wget -l 1 https://github.com/interlisp/medley/releases/latest
+./scripts/loadup-all.sh
 ```
-will retrieve a 3xx redirect from the web server;
-But all you need is the name, not the web page.
-anyway, assuming the release is medley-YYMMDD-xxxxxxx. 
 
-put release name in variable
-```
-  export release=medley-240420-1234567
-```
-## make a new branch
+# Now run in Medley "apps" loadup 
 ```
-   git checkout -b pages-$release
+  ./medley -a &
 ```
-*temporarily* change .gitignore to allow checkin of pdfs and index.html
-```
-cp .gitignore /tmp/save$release
-cp .gitignore.for.pages .gitignore
+and enter the following to make the PDFs and the index.html files that links them.
+
 ```
-Now you can push this to the github-pages
+(DRIBBLE "medley/loadups/hcfiles.dribble")
+
+(FILESLOAD MEDLEY-UTILS PDFSTREAM GITFNS)
+
+(SETQ NO-HELP NIL)
+ADVISE(HELP :BEFORE (IF NO-HELP THEN ( (ERROR MESS1 MESS2)))
+    (LET ((NO-HELP T)) (DECLARE (SPECIAL NO-HELP)) (HCFILES)))
+
+(MAKE-INDEX-HTML)
 ```
-	git add .
-	git commit -m "rerun making ghpages and index"
-	git push
+# Deploying
+
+The trick is to take a repository based on the master branch of medley and produce a gh-pages branch in the Interlisp/src reposiory.
+
 ```
+git remote set-url --push https://github.com/Interlisp/src
+git branch -D gh-pages  ## if necessary
+git checkout -b gh-pages ## make the current directory content the same
+
+## make sure the .gitignore DOESN'T ignore .pdf and index.html files
 
+git add .
+git commit -m "add created pdf's and index.html's"
+git push --force
 
+# Put it all back
 
+after you've done this, you can clean up (from the medley folder):
+```
+find . -iname "*.pdf" -exec rm {} \;
+git remote set-url --push https://github.com/Interlisp/medley
+rm -rf loops notecards test
+```