From 25584ff5baf641859f435d27b27fc0a4ffd50937 Mon Sep 17 00:00:00 2001 From: Zachary Lockwood Date: Tue, 16 Jan 2024 23:20:34 -0500 Subject: [PATCH] Initial UPE Docs --- .github/workflows/deploy.yml | 127 ++++++++++++++++++ .idea/.gitignore | 3 + .idea/UPEDocs.iml | 8 ++ .idea/modules.xml | 8 ++ .idea/vcs.xml | 6 + Writerside/c.list | 6 + Writerside/cfg/buildprofiles.xml | 19 +++ Writerside/topics/Documentation.md | 12 ++ Writerside/topics/Palette-Icons.md | 78 +++++++++++ .../topics/Property-List-Duplication.md | 6 + Writerside/topics/Property-Postinits.md | 6 + Writerside/topics/Property-Replacement.md | 6 + Writerside/upe.tree | 13 ++ Writerside/writerside.cfg | 9 ++ 14 files changed, 307 insertions(+) create mode 100644 .github/workflows/deploy.yml create mode 100644 .idea/.gitignore create mode 100644 .idea/UPEDocs.iml create mode 100644 .idea/modules.xml create mode 100644 .idea/vcs.xml create mode 100644 Writerside/c.list create mode 100644 Writerside/cfg/buildprofiles.xml create mode 100644 Writerside/topics/Documentation.md create mode 100644 Writerside/topics/Palette-Icons.md create mode 100644 Writerside/topics/Property-List-Duplication.md create mode 100644 Writerside/topics/Property-Postinits.md create mode 100644 Writerside/topics/Property-Replacement.md create mode 100644 Writerside/upe.tree create mode 100644 Writerside/writerside.cfg diff --git a/.github/workflows/deploy.yml b/.github/workflows/deploy.yml new file mode 100644 index 0000000..9c55474 --- /dev/null +++ b/.github/workflows/deploy.yml @@ -0,0 +1,127 @@ +name: Build documentation + +on: + # If specified, the workflow will be triggered automatically once you push to the `main` branch. + # Replace `main` with your branch’s name + push: + branches: ["gh-pages"] + # Specify to run a workflow manually from the Actions tab on GitHub + workflow_dispatch: + +# Gives the workflow permissions to clone the repo and create a page deployment +permissions: + id-token: write + pages: write + +env: + INSTANCE: Writerside/upe + ARTIFACT: webHelpUPE2-all.zip + # Writerside docker image version + DOCKER_VERSION: 233.4797 + + ALGOLIA_ARTIFACT: algolia-indexes-UPE.zip + ALGOLIA_APP_NAME: 5PWXFRPMT2 + ALGOLIA_INDEX_NAME: UniversalPropertyEnhancer + ALGOLIA_KEY: ${{ secrets.ALGOLIA_KEY }} + CONFIG_JSON_PRODUCT: UPE + +jobs: + build: + runs-on: ubuntu-latest + + steps: + - name: Checkout repository + uses: actions/checkout@v3 + + - name: Build Writerside docs using Docker + uses: JetBrains/writerside-github-action@v4 + with: + instance: ${{ env.INSTANCE }} + artifact: ${{ env.ARTIFACT }} + docker-version: ${{ env.DOCKER_VERSION }} + + - name: Upload documentation + uses: actions/upload-artifact@v3 + with: + name: docs + path: | + artifacts/${{ env.ARTIFACT }} + artifacts/report.json + retention-days: 7 + + # Add the step below to upload Algolia indexes + - name: Upload algolia-indexes + uses: actions/upload-artifact@v3 + with: + name: algolia-indexes + path: artifacts/${{ env.ALGOLIA_ARTIFACT }} + retention-days: 7 + + # Add the job below and artifacts/report.json on Upload documentation step above if you want to fail the build when documentation contains errors + test: + # Requires build job results + needs: build + runs-on: ubuntu-latest + + steps: + - name: Download artifacts + uses: actions/download-artifact@v1 + with: + name: docs + path: artifacts + + - name: Test documentation + uses: JetBrains/writerside-checker-action@v1 + with: + instance: ${{ env.INSTANCE }} + + deploy: + environment: + name: github-pages + url: ${{ steps.deployment.outputs.page_url }} + # Requires the build job results + needs: test + runs-on: ubuntu-latest + steps: + - name: Download artifact + uses: actions/download-artifact@v3 + with: + name: docs + + - name: Unzip artifact + run: unzip -O UTF-8 -qq ${{ env.ARTIFACT }} -d dir + + - name: Setup Pages + uses: actions/configure-pages@v2 + + - name: Upload artifact + uses: actions/upload-pages-artifact@v1 + with: + path: dir + + - name: Deploy to GitHub Pages + id: deployment + uses: actions/deploy-pages@v1 + + publish-indexes: + # Requires the build-job results + needs: build + runs-on: ubuntu-latest + container: + image: registry.jetbrains.team/p/writerside/builder/algolia-publisher:2.0.32-2 + + steps: + - name: Download artifact + uses: actions/download-artifact@v3 + with: + name: algolia-indexes + - name: Unzip artifact + run: | + unzip -O UTF-8 -qq ${{ env.ALGOLIA_ARTIFACT }} -d algolia-indexes + env "algolia-key=${{env.ALGOLIA_KEY}}" java -jar /opt/builder/help-publication-agent.jar \ + update-index \ + --application-name ${{env.ALGOLIA_APP_NAME}} \ + --index-name ${{env.ALGOLIA_INDEX_NAME}} \ + --product ${{env.CONFIG_JSON_PRODUCT}} \ + --index-directory algolia-indexes/ \ + 2>&1 | tee algolia-update-index-log.txt diff --git a/.idea/.gitignore b/.idea/.gitignore new file mode 100644 index 0000000..26d3352 --- /dev/null +++ b/.idea/.gitignore @@ -0,0 +1,3 @@ +# Default ignored files +/shelf/ +/workspace.xml diff --git a/.idea/UPEDocs.iml b/.idea/UPEDocs.iml new file mode 100644 index 0000000..6102194 --- /dev/null +++ b/.idea/UPEDocs.iml @@ -0,0 +1,8 @@ + + + + + + + + \ No newline at end of file diff --git a/.idea/modules.xml b/.idea/modules.xml new file mode 100644 index 0000000..c454da2 --- /dev/null +++ b/.idea/modules.xml @@ -0,0 +1,8 @@ + + + + + + + + \ No newline at end of file diff --git a/.idea/vcs.xml b/.idea/vcs.xml new file mode 100644 index 0000000..35eb1dd --- /dev/null +++ b/.idea/vcs.xml @@ -0,0 +1,6 @@ + + + + + + \ No newline at end of file diff --git a/Writerside/c.list b/Writerside/c.list new file mode 100644 index 0000000..606bb1b --- /dev/null +++ b/Writerside/c.list @@ -0,0 +1,6 @@ + + + + + + \ No newline at end of file diff --git a/Writerside/cfg/buildprofiles.xml b/Writerside/cfg/buildprofiles.xml new file mode 100644 index 0000000..db8551b --- /dev/null +++ b/Writerside/cfg/buildprofiles.xml @@ -0,0 +1,19 @@ + + + + 27d4a07e94debd4132df703014b6e331 + + + + 5PWXFRPMT2 + UniversalPropertyEnhancer + false + https://zarklord.github.io + strawberry + +
+ Zarklord 2018-2024 +
+ + diff --git a/Writerside/topics/Documentation.md b/Writerside/topics/Documentation.md new file mode 100644 index 0000000..ae9dab5 --- /dev/null +++ b/Writerside/topics/Documentation.md @@ -0,0 +1,12 @@ +# Documentation + +You can find developer documentation for Universal Property Enhancer here. + + + + + + + + + \ No newline at end of file diff --git a/Writerside/topics/Palette-Icons.md b/Writerside/topics/Palette-Icons.md new file mode 100644 index 0000000..07b5d0d --- /dev/null +++ b/Writerside/topics/Palette-Icons.md @@ -0,0 +1,78 @@ +# Palette Icons +Use UPE to add custom palette icons to your part pages +Use UPE to add custom palette icons to your part pages +Use UPE to add custom palette icons to your part pages + +All palette icon data is defined inside the paletteicons folder, so you must first create that folder in your mod. + +Create a .prop file with a unique name in the paletteicons folder. + +

+ Ensure that all prop files in the paletteicons folder have a unique name, if they share a name with another mod, it won't work. +

+ + +

+ It's usually a good idea to use your mod's name, to reduce the chance of conflicting with other mods. +

+ + +Add the following properties to that prop file: + +
  • + + key paletteSetButtonBackgroundIcon common~!bgicon.png + +

    + Edit common~!bgicon.png to point to your icon background. +

    +
    • +
  • + + key paletteSetButtonIcon common~!icon.png + +

    + Edit common~!icon.png to point to your icon. +

    +
    • +
  • + + key paletteSetButtonLayout layouts~!0x98F661C7.layout + +

    + Usually, you don't need to edit this. +

    +
    • +
  • + + texts paletteSetName + (0x0!0x0) "" + end + +

    + This is the text that appears when you hover, point it to your locale property and your text. +

    +
    • +
  • + + int32 paletteSetSequenceNumber 1025 + +

    + This determines the ordering of palette icons in relation to each other +

    + +

    + This does not control the ordering of pages, so if this is set improperly, + its possible for your icon to appear out of order compared to the pages it's on. +

    +     +
    • +     + +Then for every page you want to have your icon, add the following property: + +int32 palettePageSetId hash(PALETTEICONPROP) + +

    +Edit PALETTEICONPROP to be the name of your palette icon prop file (excluding the file extension). +

    \ No newline at end of file diff --git a/Writerside/topics/Property-List-Duplication.md b/Writerside/topics/Property-List-Duplication.md new file mode 100644 index 0000000..324ac1f --- /dev/null +++ b/Writerside/topics/Property-List-Duplication.md @@ -0,0 +1,6 @@ +# Property List Duplication +Use UPE to duplicate property lists to new locations +Use UPE to duplicate property lists to new locations +Use UPE to duplicate property lists to new locations + +TODO \ No newline at end of file diff --git a/Writerside/topics/Property-Postinits.md b/Writerside/topics/Property-Postinits.md new file mode 100644 index 0000000..578869d --- /dev/null +++ b/Writerside/topics/Property-Postinits.md @@ -0,0 +1,6 @@ +# Property Postinits +Use UPE to modify existing property lists +Use UPE to modify existing property lists +Use UPE to modify existing property lists + +TODO \ No newline at end of file diff --git a/Writerside/topics/Property-Replacement.md b/Writerside/topics/Property-Replacement.md new file mode 100644 index 0000000..5fc7846 --- /dev/null +++ b/Writerside/topics/Property-Replacement.md @@ -0,0 +1,6 @@ +# Property Replacement +Use UPE to universally replace properties +Use UPE to universally replace properties +Use UPE to universally replace properties + +TODO \ No newline at end of file diff --git a/Writerside/upe.tree b/Writerside/upe.tree new file mode 100644 index 0000000..2611ee6 --- /dev/null +++ b/Writerside/upe.tree @@ -0,0 +1,13 @@ + + + + + + \ No newline at end of file diff --git a/Writerside/writerside.cfg b/Writerside/writerside.cfg new file mode 100644 index 0000000..1c16368 --- /dev/null +++ b/Writerside/writerside.cfg @@ -0,0 +1,9 @@ + + + + + + + + + \ No newline at end of file