diff --git a/.github/workflows/tests.yml b/.github/workflows/tests.yml index 9ede484d..1b461d59 100644 --- a/.github/workflows/tests.yml +++ b/.github/workflows/tests.yml @@ -11,12 +11,13 @@ on: - '[34].[0-9]+.x' jobs: - build: + build-dev-docs: + name: 'Build development docs' runs-on: ubuntu-latest steps: - - uses: actions/checkout@v2 + - uses: actions/checkout@v4 - name: Set up Python - uses: actions/setup-python@v2 + uses: actions/setup-python@v4 with: python-version: '3.x' - name: Install dependencies @@ -31,3 +32,35 @@ jobs: run: | cd development make html + + build-user-docs-pdf: + name: 'Build user docs PDF' + runs-on: ubuntu-latest + steps: + - uses: actions/checkout@v4 + - name: Install fop + run: | + sudo apt-get install -y fop + - name: Build pdf documentation + working-directory: ${{ github.workspace }}/documentation + run: | + ./create_pdf.sh + - name: Archive PDF output + uses: actions/upload-artifact@v4 + with: + name: Documentation PDF + path: ${{ github.workspace }}/documentation/*.pdf + + build-user-docs-website: + name: 'Build user docs for website' + runs-on: ubuntu-latest + steps: + - uses: actions/checkout@v4 + - name: Install xsltproc + run: | + sudo apt-get install -y xsltproc + - name: Build documentation for website + working-directory: ${{ github.workspace }}/documentation + run: | + mkdir build_website + ./create_docs.sh build_website diff --git a/.gitignore b/.gitignore index 789caf07..7114a1b4 100644 --- a/.gitignore +++ b/.gitignore @@ -1,4 +1,5 @@ Thumbs.db .DS_Store +.idea/ /development/_build /documentation/build diff --git a/documentation/content/cs/chapters/admin_guide.xml b/documentation/content/cs/chapters/admin_guide.xml index f43dcdd4..ab6ccda1 100644 --- a/documentation/content/cs/chapters/admin_guide.xml +++ b/documentation/content/cs/chapters/admin_guide.xml @@ -1,5 +1,4 @@ - diff --git a/documentation/content/cs/chapters/glossary.xml b/documentation/content/cs/chapters/glossary.xml index 702279c1..7345aa98 100644 --- a/documentation/content/cs/chapters/glossary.xml +++ b/documentation/content/cs/chapters/glossary.xml @@ -1,5 +1,4 @@ - diff --git a/documentation/content/cs/chapters/moderator_guide.xml b/documentation/content/cs/chapters/moderator_guide.xml index ef7e3a5c..27e8e6c9 100644 --- a/documentation/content/cs/chapters/moderator_guide.xml +++ b/documentation/content/cs/chapters/moderator_guide.xml @@ -1,6 +1,4 @@ - diff --git a/documentation/content/cs/chapters/quick_start_guide.xml b/documentation/content/cs/chapters/quick_start_guide.xml index f6cb1691..9eae896e 100644 --- a/documentation/content/cs/chapters/quick_start_guide.xml +++ b/documentation/content/cs/chapters/quick_start_guide.xml @@ -1,6 +1,4 @@ - diff --git a/documentation/content/cs/chapters/upgrade_guide.xml b/documentation/content/cs/chapters/upgrade_guide.xml index 43a7e08e..5bf58c6d 100644 --- a/documentation/content/cs/chapters/upgrade_guide.xml +++ b/documentation/content/cs/chapters/upgrade_guide.xml @@ -1,6 +1,4 @@ - diff --git a/documentation/content/cs/chapters/user_guide.xml b/documentation/content/cs/chapters/user_guide.xml index 22da96ee..612f564b 100644 --- a/documentation/content/cs/chapters/user_guide.xml +++ b/documentation/content/cs/chapters/user_guide.xml @@ -1,6 +1,4 @@ - diff --git a/documentation/content/da/chapters/admin_guide.xml b/documentation/content/da/chapters/admin_guide.xml index 8330c0ed..bcac3f06 100644 --- a/documentation/content/da/chapters/admin_guide.xml +++ b/documentation/content/da/chapters/admin_guide.xml @@ -1,6 +1,4 @@ - diff --git a/documentation/content/da/chapters/glossary.xml b/documentation/content/da/chapters/glossary.xml index 179855e0..d0bd2cbe 100644 --- a/documentation/content/da/chapters/glossary.xml +++ b/documentation/content/da/chapters/glossary.xml @@ -1,6 +1,4 @@ - diff --git a/documentation/content/da/chapters/moderator_guide.xml b/documentation/content/da/chapters/moderator_guide.xml index 3712b8b6..82bb2718 100644 --- a/documentation/content/da/chapters/moderator_guide.xml +++ b/documentation/content/da/chapters/moderator_guide.xml @@ -1,6 +1,4 @@ - diff --git a/documentation/content/da/chapters/quick_start_guide.xml b/documentation/content/da/chapters/quick_start_guide.xml index 11dd86e6..0a41e6eb 100644 --- a/documentation/content/da/chapters/quick_start_guide.xml +++ b/documentation/content/da/chapters/quick_start_guide.xml @@ -1,6 +1,4 @@ - diff --git a/documentation/content/da/chapters/upgrade_guide.xml b/documentation/content/da/chapters/upgrade_guide.xml index 381cb140..27b0afa8 100644 --- a/documentation/content/da/chapters/upgrade_guide.xml +++ b/documentation/content/da/chapters/upgrade_guide.xml @@ -1,6 +1,4 @@ - diff --git a/documentation/content/da/chapters/user_guide.xml b/documentation/content/da/chapters/user_guide.xml index 0102c843..ebd308b4 100644 --- a/documentation/content/da/chapters/user_guide.xml +++ b/documentation/content/da/chapters/user_guide.xml @@ -1,6 +1,4 @@ - diff --git a/documentation/content/de/chapters/glossary.xml b/documentation/content/de/chapters/glossary.xml index aa94d711..cd5b40d4 100644 --- a/documentation/content/de/chapters/glossary.xml +++ b/documentation/content/de/chapters/glossary.xml @@ -1,5 +1,4 @@ - diff --git a/documentation/content/en/chapters/admin_guide.xml b/documentation/content/en/chapters/admin_guide.xml index 96f3f84b..345c35c2 100644 --- a/documentation/content/en/chapters/admin_guide.xml +++ b/documentation/content/en/chapters/admin_guide.xml @@ -1,6 +1,4 @@ - diff --git a/documentation/content/en/chapters/glossary.xml b/documentation/content/en/chapters/glossary.xml index 528df848..6f4b64b2 100644 --- a/documentation/content/en/chapters/glossary.xml +++ b/documentation/content/en/chapters/glossary.xml @@ -1,6 +1,4 @@ - diff --git a/documentation/content/en/chapters/moderator_guide.xml b/documentation/content/en/chapters/moderator_guide.xml index 7127396c..42b6b4f4 100644 --- a/documentation/content/en/chapters/moderator_guide.xml +++ b/documentation/content/en/chapters/moderator_guide.xml @@ -1,6 +1,4 @@ - diff --git a/documentation/content/en/chapters/quick_start_guide.xml b/documentation/content/en/chapters/quick_start_guide.xml index 84cab670..e74c753e 100644 --- a/documentation/content/en/chapters/quick_start_guide.xml +++ b/documentation/content/en/chapters/quick_start_guide.xml @@ -1,6 +1,4 @@ - diff --git a/documentation/content/en/chapters/server_guide.xml b/documentation/content/en/chapters/server_guide.xml index f41da88e..3e211c4c 100644 --- a/documentation/content/en/chapters/server_guide.xml +++ b/documentation/content/en/chapters/server_guide.xml @@ -1,6 +1,4 @@ - diff --git a/documentation/content/en/chapters/upgrade_guide.xml b/documentation/content/en/chapters/upgrade_guide.xml index 6d934bf0..fdaff09d 100644 --- a/documentation/content/en/chapters/upgrade_guide.xml +++ b/documentation/content/en/chapters/upgrade_guide.xml @@ -1,6 +1,4 @@ - diff --git a/documentation/content/en/chapters/user_guide.xml b/documentation/content/en/chapters/user_guide.xml index 75e4ae54..b71b9ec7 100644 --- a/documentation/content/en/chapters/user_guide.xml +++ b/documentation/content/en/chapters/user_guide.xml @@ -1,6 +1,4 @@ - @@ -421,7 +419,7 @@ Drafts When creating a post, it can be saved or loaded using the drafts feature. If the board permissions allow drafts to be saved, then Save and Load buttons will appear on the posting page. - Save - Saves a post as a draft. When a draft is saved, only the subject and message of the post are stored. Topic icons, attachments, etc… will be lost. + Save - Saves a post as a draft. When a draft is saved, only the subject and message of the post are stored. Topic icons, attachments, etc... will be lost. Load - Loads a saved draft. When clicked, a listing of available drafts will appear. Click the title of the desired post to load the draft. Any information in the current post will be lost and replaced with that of the draft. Once a draft is used, it is removed. For more information on managing drafts, please see UCP Drafts. diff --git a/documentation/content/hu/chapters/admin_guide.xml b/documentation/content/hu/chapters/admin_guide.xml index 405a1202..b2d7816a 100644 --- a/documentation/content/hu/chapters/admin_guide.xml +++ b/documentation/content/hu/chapters/admin_guide.xml @@ -1,6 +1,4 @@ - diff --git a/documentation/content/hu/chapters/glossary.xml b/documentation/content/hu/chapters/glossary.xml index d7be9adb..2dd9b182 100644 --- a/documentation/content/hu/chapters/glossary.xml +++ b/documentation/content/hu/chapters/glossary.xml @@ -1,6 +1,4 @@ - diff --git a/documentation/content/hu/chapters/moderator_guide.xml b/documentation/content/hu/chapters/moderator_guide.xml index 48efb461..b0c7dcf6 100644 --- a/documentation/content/hu/chapters/moderator_guide.xml +++ b/documentation/content/hu/chapters/moderator_guide.xml @@ -1,6 +1,4 @@ - diff --git a/documentation/content/hu/chapters/quick_start_guide.xml b/documentation/content/hu/chapters/quick_start_guide.xml index bacf6272..653545ce 100644 --- a/documentation/content/hu/chapters/quick_start_guide.xml +++ b/documentation/content/hu/chapters/quick_start_guide.xml @@ -1,6 +1,4 @@ - diff --git a/documentation/content/hu/chapters/upgrade_guide.xml b/documentation/content/hu/chapters/upgrade_guide.xml index cbd2b989..cbb3580a 100644 --- a/documentation/content/hu/chapters/upgrade_guide.xml +++ b/documentation/content/hu/chapters/upgrade_guide.xml @@ -1,6 +1,4 @@ - diff --git a/documentation/content/hu/chapters/user_guide.xml b/documentation/content/hu/chapters/user_guide.xml index 93dbed3d..f71131a4 100644 --- a/documentation/content/hu/chapters/user_guide.xml +++ b/documentation/content/hu/chapters/user_guide.xml @@ -1,6 +1,4 @@ - diff --git a/documentation/content/nl/chapters/admin_guide.xml b/documentation/content/nl/chapters/admin_guide.xml index 2e6f79e9..d18e86a4 100644 --- a/documentation/content/nl/chapters/admin_guide.xml +++ b/documentation/content/nl/chapters/admin_guide.xml @@ -1,6 +1,4 @@ - diff --git a/documentation/content/nl/chapters/glossary.xml b/documentation/content/nl/chapters/glossary.xml index fdd4a2ed..6cc0262a 100644 --- a/documentation/content/nl/chapters/glossary.xml +++ b/documentation/content/nl/chapters/glossary.xml @@ -1,6 +1,4 @@ - diff --git a/documentation/content/nl/chapters/moderator_guide.xml b/documentation/content/nl/chapters/moderator_guide.xml index d01b992d..4a20dd20 100644 --- a/documentation/content/nl/chapters/moderator_guide.xml +++ b/documentation/content/nl/chapters/moderator_guide.xml @@ -1,6 +1,4 @@ - diff --git a/documentation/content/nl/chapters/quick_start_guide.xml b/documentation/content/nl/chapters/quick_start_guide.xml index 631f4877..19bd6e62 100644 --- a/documentation/content/nl/chapters/quick_start_guide.xml +++ b/documentation/content/nl/chapters/quick_start_guide.xml @@ -1,6 +1,4 @@ - diff --git a/documentation/content/nl/chapters/upgrade_guide.xml b/documentation/content/nl/chapters/upgrade_guide.xml index 51fb7ed3..59418bcb 100644 --- a/documentation/content/nl/chapters/upgrade_guide.xml +++ b/documentation/content/nl/chapters/upgrade_guide.xml @@ -1,6 +1,4 @@ - diff --git a/documentation/content/nl/chapters/user_guide.xml b/documentation/content/nl/chapters/user_guide.xml index e9c18a30..7899ffcc 100644 --- a/documentation/content/nl/chapters/user_guide.xml +++ b/documentation/content/nl/chapters/user_guide.xml @@ -1,6 +1,4 @@ - diff --git a/documentation/content/pl/admin_guide.xml b/documentation/content/pl/admin_guide.xml index 008a72dd..7e82ba1f 100644 --- a/documentation/content/pl/admin_guide.xml +++ b/documentation/content/pl/admin_guide.xml @@ -1,6 +1,4 @@ - diff --git a/documentation/content/pl/glossary.xml b/documentation/content/pl/glossary.xml index 5dd3abd7..b1c1655e 100644 --- a/documentation/content/pl/glossary.xml +++ b/documentation/content/pl/glossary.xml @@ -1,6 +1,4 @@ - diff --git a/documentation/content/pl/moderator_guide.xml b/documentation/content/pl/moderator_guide.xml index ca32e93b..636d3777 100644 --- a/documentation/content/pl/moderator_guide.xml +++ b/documentation/content/pl/moderator_guide.xml @@ -1,6 +1,4 @@ - diff --git a/documentation/content/pl/quick_start_guide.xml b/documentation/content/pl/quick_start_guide.xml index 360a4291..6583d66a 100644 --- a/documentation/content/pl/quick_start_guide.xml +++ b/documentation/content/pl/quick_start_guide.xml @@ -1,6 +1,4 @@ - diff --git a/documentation/content/pl/upgrade_guide.xml b/documentation/content/pl/upgrade_guide.xml index 17540420..77591389 100644 --- a/documentation/content/pl/upgrade_guide.xml +++ b/documentation/content/pl/upgrade_guide.xml @@ -1,6 +1,4 @@ - diff --git a/documentation/content/pl/user_guide.xml b/documentation/content/pl/user_guide.xml index 81dcac9f..a8e02130 100644 --- a/documentation/content/pl/user_guide.xml +++ b/documentation/content/pl/user_guide.xml @@ -1,6 +1,4 @@ - diff --git a/documentation/create_docs.sh b/documentation/create_docs.sh index b8be6ec1..53c7b394 100755 --- a/documentation/create_docs.sh +++ b/documentation/create_docs.sh @@ -1,15 +1,16 @@ #!/bin/bash # set this to the correct path -path="/var/www/phpbb.com/htdocs/support/documentation/3.3" +path=${1:-'/var/www/phpbb.com/htdocs/support/documentation/3.3'} echo "Removing build directory" rm -rf build echo "Creating docs" xsltproc --xinclude xsl/proteus_php.xsl proteus_doc.xml +exit_code=$? # Capture the exit code -if [ "$?" == "0" ]; then +if [ "$exit_code" == "0" ]; then echo "Successfully created documentation" echo "Removing $path" rm -rf $path @@ -24,3 +25,6 @@ if [ "$?" == "0" ]; then else echo "Failed creating documentation" fi + +# Output exit code +exit $exit_code diff --git a/documentation/create_pdf.sh b/documentation/create_pdf.sh old mode 100644 new mode 100755 index d67f8383..46439462 --- a/documentation/create_pdf.sh +++ b/documentation/create_pdf.sh @@ -1,7 +1,9 @@ #!/bin/bash echo "Removing previous PDF" -rm proteus_doc.pdf +if [ -f proteus_doc.pdf ]; then + rm proteus_doc.pdf +fi echo "Creating new PDF" fop -xml proteus_doc.xml -xsl xsl/proteus_pdf.xsl -pdf proteus_doc.pdf diff --git a/documentation/proteus_doc.xml b/documentation/proteus_doc.xml index 45343fc5..b7cbc825 100644 --- a/documentation/proteus_doc.xml +++ b/documentation/proteus_doc.xml @@ -1,10 +1,4 @@ - - %xinclude; - - ]> phpBB 3.3 <emphasis>Proteus</emphasis> Documentation