Skip to content

Commit

Permalink
Initial localization support for Help documentation (#6)
Browse files Browse the repository at this point in the history
* Work on additional languages

- Organize languages into subfolders
- Initial Spanish support

* Translation update

Spanish translation update for help documentation contents (2024/01/23)

* Translation updates (2024/01/24)

40th Macintosh Anniversary update:

- More items have received Spanish translations
- Readme file now has site generation section

* Update README.md

* Add Recents list documentation

* DISMTools Help Contents Localization Update (part 1) (#5)

* Update product images

* Update Getting Started resources

* Resource update (part 3)

Updated the majority of resources of the "img_tasks" folder

* Resource update (part 4)

* Update site_gen.ps1

Perform regex replace for CSS fixes

* Documentation update (2024/06/10)

* DISMTools Help Content Updates (2024/06/14)

* DISMTools Help Documentation Updates (2024/06/15)

* DISMTools Help Documentation Updates (2024/06/20)

- Added driver import task (en)
- Replaced all references of Server vNext with Server 2025
  • Loading branch information
CodingWonders authored Jul 14, 2024
1 parent 239478c commit 07de4fa
Show file tree
Hide file tree
Showing 294 changed files with 2,034 additions and 21 deletions.
14 changes: 14 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,20 @@ This is the in-progress help documentation content for DISMTools, which will be
5. Create your changes and test
6. Once you've done your contributions, create a pull request

### Building the final site

To build the final sites for all languages, do the following:

1. Open a terminal window in the directory you have cloned the repo to
2. Type `powershell .\site_gen.ps1`

> [!NOTE]
> If you see a security warning, you need to unblock the file. To do this:
> - Select the file, go to Properties and click "Unblock"
> - Type in that terminal window the following: `powershell -command Unblock-File .\site_gen.ps1`
Finally, you'll have all languages in the `site` folders of all languages.

## Additional notes

- When adding full-window screenshots, ShareX is recommended and must be configured for window transparency capture. Go to the capture settings and enable such option
Expand Down
Binary file not shown.
Binary file removed docs/docs/res/getting_started/mount_an_image.png
Binary file not shown.
Binary file removed docs/docs/res/getting_started/project_view.png
Binary file not shown.
Binary file removed docs/docs/res/img_tasks/cmd_menu.png
Binary file not shown.
Binary file removed docs/docs/res/img_tasks/quick_actions.png
Binary file not shown.
Binary file removed docs/docs/res/product.png
Binary file not shown.
Original file line number Diff line number Diff line change
Expand Up @@ -20,4 +20,4 @@ With MSMG Toolkit, you have to copy the files from a Windows Setup disc to the `

If you've loaded a Windows image into MSMG Toolkit and closed it, the program will unmount it. If you force the closure of the program and launch it again, it will remove EVERY file from the Windows image, making it **invalid** and **unrepairable**. This can be done because the Toolkit is launched as `TrustedInstaller` by default. You don't need to worry about that with DISMTools. After mounting an image to a project, it will stay there, even if you close the program; until you want to unmount it. Also, the program will **leave the mounted images alone** when starting up, apart from [reloading their servicing sessions](../img_tasks/mgmt/remount_image.md) if the images need a remount.

With MSMG Toolkit, you can only manage Windows images. However, with DISMTools, you can manage Windows images and (active) installations.
With MSMG Toolkit, you can only manage Windows images. However, with DISMTools, you can manage Windows images and installations of any kind.
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ In 2007, Microsoft introduced Windows Vista, which would make lots of changes to

With Windows Vista, Microsoft also introduced the Automated Installation Kit (AIK), which contains the deployment tools necessary for that operating system. Tools, such as ImageX (deploys images), Package Manager (deploys packages), IntlCfg (configures regional settings) or more; were included with this kit. However, Microsoft wanted to create a solution that would streamline the deployment process.

Their answer was the **Deployment Image Servicing and Management** (DISM) tool, which does every action performed by the aforementioned utilities in a single command-line program. DISM was released alongside Windows 7, and has been improved since; with the addition of the API and PowerShell cmdlets and more.
Their answer was the **Deployment Image Servicing and Management** (DISM) tool, which does every action performed by the aforementioned utilities in a single command-line program. DISM was released alongside Windows 7, and has been improved since; with the addition of the API, PowerShell cmdlets and more.

Nowadays, if you want to manage Windows images, DISM is one tool to master.

Expand All @@ -20,7 +20,7 @@ Open-source alternatives are also available, such as:
- [DISM GUI](https://github.com/mikecel79/DISMGUI)
- [DISM++](https://github.com/Chuyu-Team/Dism-Multi-language)

And, since you're browsing this site, **DISMTools** is another new alternative. If you want to try it out, or you're moving your workflow to this program, follow the "Coming from..." links in the Getting started section.
And, since you're browsing this site, **DISMTools** is another new alternative.

## Useful resources

Expand Down
File renamed without changes.
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,11 @@ After providing data on both fields, click OK. The project will be created and y

To load this project later, go to "Open an existing project..." and specify the project location.

**NOTE:** in the future, a Recents list will be implemented
If you have loaded a project recently, it's added to the Recents list. To access a project, double-click its entry in the list; and to remove an entry select it and click Remove entry.

<p align="center">
<img src="../../res/getting_started/recents_list.png"/>
</p>

### Loading a Windows image

Expand Down
File renamed without changes.
108 changes: 108 additions & 0 deletions en/docs/img_tasks/appx/add_provisionedappxpackage.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,108 @@
# Adding provisioned AppX packages

<p align="center">
<img src="../../../res/img_tasks/appx/add_provisionedappxpackage.png" />
</p>

With DISMTools you can add provisioned AppX packages using an intuitive UI. This action can be accessed by clicking Commands > App packages > Add provisioned app package...

## Target OS support

This action is supported on the following platforms:

| Platform | Supported? |
|:--:|:--:|
| Windows 7/Server 2008 R2 ||
| Windows 8/Server 2012 ||
| Windows 8.1/Server 2012 R2 ||
| Windows 10/Server 2016/2019/2022 ||
| Windows 11/Server 2025 ||

**NOTE:** if you are adding provisioned AppX packages to an online installation, you may need to enable sideloading of applications. Otherwise, you may get error code `0xc1570113`. More information can be found [here](https://learn.microsoft.com/en-us/windows-hardware/manufacture/desktop/sideload-apps-with-dism-s14?view=windows-11#configure-pcs-for-developing-windows-apps). You may also need to properly **register the application to the operating system** for it to fully work, a guide for which is explained later in this page.

<i>This action is supported on DISMTools 0.2 and newer</i>

## Usage

- Add any application file you want to add to a Windows image, which can be in the `.appx`, `.msix`, `.appxbundle` or `.msixbundle` format, to the **AppX package list**. This can be done by using the buttons on the bottom of the dialog, or by dropping them from an **elevated** application.
- If an application contains dependencies, be sure to add these to the **AppX dependency list**, by using the buttons below or by dropping them from an elevated application

### App Installer support

DISMTools 0.3.2 expands the AppX addition capabilities by supporting App Installer files. Simply specify an `.appinstaller` file or drop it in the package addition list view, and let the program deal with it.

You can learn more about App Installer files [here](./appx.md#app-installer-files).

### Encrypted application support

DISMTools 0.5 introduces the ability to add encrypted application packages (`.eappx`, `.emsix`, `.eappxbundle`, and `.emsixbundle` files) to **active installations**. Simply add those, just like you would with regular applications.

For standard encrypted applications (not bundles), you can also view standard information about them, thanks to a modified version of [UnpEax](https://github.com/dalion619/UnpEax):

<p align="center">
<img src="../../../res/img_tasks/appx/eappx_support.png" />
</p>

*Encrypted application bundle package support will come in a future version.*

You may notice that all options are disabled. This is because the program uses a PowerShell command to add these applications, as they can't be added using DISM.

## Options

- A **license file** may be required for an application to be installed, which you can specify in the license file text box. Otherwise, select "Skip license"
- If you want, you can **provide a custom data file**
- If you want to provision applications in some regions, specify them, separated by a semi-colon (;); following the [ISO 3166-1 Alpha 2](https://en.wikipedia.org/wiki/ISO_3166-1) or [Alpha 3](https://en.wikipedia.org/wiki/ISO_3166-1) codes

**NOTE:** specifying a region requires DISM for Windows 10 and/or a Windows 10 or later image.

- If you want, you can **commit the image after adding the selected AppX packages**.

## Questions

**Q: Where can I download app packages?**

**A:** You can make use of the [Microsoft Store Generation Project](https://store.rg-adguard.net/) and the [web version of the Microsoft Store](https://apps.microsoft.com/store/apps). Follow these steps:

1. Load the Microsoft Apps website and search for the application you are looking for
2. Once you've found your desired application, **copy its link**. It will be useful for the generation project
3. Load the generation project website and paste the link you've copied
4. If the server returns results, download the desired version of the AppX package **and its dependencies**

<p align="center">
<img src="../../../res/img_tasks/appx/microsoft_apps.png" />
</p>

<p align="center">
<img src="../../../res/img_tasks/appx/store_rg-adguard.png" />
</p>

If your browser complains about the safety of the files, confirm you want to download them.

**Q: I've installed an application on an online installation using this method, but the application doesn't work. Why?**

**A:** This may occur because the application is not fully registered. To do this, you need to make use of the registry and PowerShell:

1. Open the Registry Editor, go to `HKEY_LOCAL_MACHINE\SOFTWARE\Microsoft\Windows\CurrentVersion\Appx\AppxAllUserStore\Applications` and grab the name of the application you want to register
2. Next, open PowerShell as an administrator and type the following:

```powershell
Get-ItemPropertyValue -Path 'HKLM:\SOFTWARE\Microsoft\Windows\CurrentVersion\Appx\AppxAllUserStore\Applications\*<PackageName>*\' -Name "Path" | Add-AppxPackage -DisableDevelopmentMode -Register
```

(where `*<PackageName>*` is the name of the package you want to register)

- If the command complains about `%SYSTEMDRIVE%` being in the `Path` value, replace it with the drive you've booted to, like this:

```powershell
(Get-ItemPropertyValue -Path 'HKLM:\SOFTWARE\Microsoft\Windows\CurrentVersion\Appx\AppxAllUserStore\Applications\*<PackageName>*\' -Name "Path").Replace('%SYSTEMDRIVE%', 'C:').Trim() | Add-AppxPackage -DisableDevelopmentMode -Register
```

(obviously, replace "C:" with your boot drive)

- If the command complains about a missing dependency, download it, then add it using DISM, then use the same procedure

The application should be fully registered now. Do note that the application will still not work if you are logged into the built-in Administrator account. In that case, you need to create a new user.

## Related topics

- [Command-line help](https://example.com)
Original file line number Diff line number Diff line change
Expand Up @@ -78,7 +78,7 @@ What we're interested in is the `<MainBundle>` section, which defines the packag
The `Uri` property is what matters. DISMTools versions from 0.3.2 onwards read these files, detect a URL, and perform a file download.

<p align="center">
<img src="https://github.com/CodingWonders/DISMTools/assets/101426328/574fcec6-78c9-4211-a28c-129ee5f0cd05" />
<img src="../../../res/img_tasks/appx/appinstaller_down.png" />
</p>

You can view the reference of App Installer files [here](https://learn.microsoft.com/en-us/uwp/schemas/appinstallerschema/schema-root).
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ This action is supported on the following platforms:
| Windows 8/Server 2012 ||
| Windows 8.1/Server 2012 R2 ||
| Windows 10/Server 2016/2019/2022 ||
| Windows 11/Server vNext ||
| Windows 11/Server 2025 ||

**NOTE:** if you are removing AppX packages from a Windows Server Core installation, the Desktop Experience feature needs to be installed. **Do not remove the Desktop Experience feature before removing the desired AppX packages.**

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ This action is supported on the following platforms:
| Windows 8/Server 2012 ||
| Windows 8.1/Server 2012 R2 ||
| Windows 10/Server 2016/2019/2022 ||
| Windows 11/Server vNext ||
| Windows 11/Server 2025 ||

<i>This action is supported on DISMTools 0.3 and newer</i>

Expand Down
File renamed without changes.
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ This action is supported on the following platforms:
| Windows 8/Server 2012 ||
| Windows 8.1/Server 2012 R2 ||
| Windows 10/Server 2016/2019/2022 ||
| Windows 11/Server vNext ||
| Windows 11/Server 2025 ||

<i>This action is supported on DISMTools 0.3 and newer</i>

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ This action is supported on the following platforms:
| Windows 8/Server 2012 ||
| Windows 8.1/Server 2012 R2 ||
| Windows 10/Server 2016/2019/2022 ||
| Windows 11/Server vNext ||
| Windows 11/Server 2025 ||

<i>This action is supported on DISMTools 0.3 and newer</i>

Expand Down
File renamed without changes.
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ This action is supported on the following platforms:
| Windows 8/Server 2012 ||
| Windows 8.1/Server 2012 R2 ||
| Windows 10/Server 2016/2019/2022 ||
| Windows 11/Server vNext ||
| Windows 11/Server 2025 ||

<i>This action is supported on DISMTools 0.3.2 and newer</i>

Expand Down
49 changes: 49 additions & 0 deletions en/docs/img_tasks/drivers/import_driver.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,49 @@
# Importing drivers

<p align="center">
<img src="../../../res/img_tasks/drivers/import_driver.png" />
</p>

With DISMTools you can easily import all third-party drivers of a Windows image to another image. This guarantees that the resulting image will have the same hardware compatibility as the source image. This action can be accessed by clicking Commands > Drivers > Import driver packages...

## Target OS support

This action is supported on the following platforms:

| Platform | Supported? |
|:--:|:--:|
| Windows 7/Server 2008 R2 ||
| Windows 8/Server 2012 ||
| Windows 8.1/Server 2012 R2 ||
| Windows 10/Server 2016/2019/2022 ||
| Windows 11/Server 2025 ||

<i>This action is supported on DISMTools 0.4.1 and newer</i>

## Usage

1. Specify the source from which to export the drivers:

- **Image file** will import all third-party drivers of another image. You will need to specify the source image, which you can pick from the list of mounted images

<p align="center">
<img src="../../../res/img_tasks/drivers/import_driver_winimage.png" />
</p>

- **Online installation** will import all third-party drivers of your active installation

<p align="center">
<img src="../../../res/img_tasks/drivers/import_driver_active.png" />
</p>

- **Offline installation** will import all third-party drivers of the desired deployed image. Simply specify the source drive

<p align="center">
<img src="../../../res/img_tasks/drivers/import_driver_deployed.png" />
</p>

2. Click OK after you've made your selection

## Remarks

- Once drivers have been imported, the target image **should not be used** on computers other than the computer with the drivers of the source image, **unless they are removed**
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ This action is supported on the following platforms:
| Windows 8/Server 2012 ||
| Windows 8.1/Server 2012 R2 ||
| Windows 10/Server 2016/2019/2022 ||
| Windows 11/Server vNext ||
| Windows 11/Server 2025 ||

<i>This action is supported on DISMTools 0.3 and newer</i>

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ This action is supported on the following platforms:
| Windows 8/Server 2012 ||
| Windows 8.1/Server 2012 R2 ||
| Windows 10/Server 2016/2019/2022 ||
| Windows 11/Server vNext ||
| Windows 11/Server 2025 ||

<i>This action is supported on DISMTools 0.1.1 and newer</i>

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ This action is supported on the following platforms:
| Windows 8/Server 2012 ||
| Windows 8.1/Server 2012 R2 ||
| Windows 10/Server 2016/2019/2022 ||
| Windows 11/Server vNext ||
| Windows 11/Server 2025 ||

<i>This action is supported on DISMTools 0.1.1 and newer</i>

Expand Down
File renamed without changes.
Original file line number Diff line number Diff line change
Expand Up @@ -22,32 +22,42 @@ Do note that these options become accessible when you create a project and mount

- Image management

- Appending changes to a new index in the Windows image
- Applying Windows images
- Capturing Windows images
- Cleaning up mount points
- Exporting Windows images
- Getting image file information
- Performing image cleanup

- Package management

- Adding packages
- Removing packages
- Getting package information

- Feature management

- Enabling features
- Disabling features
- Getting feature information

- AppX package management

- AppX package documentation
- Adding AppX packages
- Removing AppX packages
- Getting installed AppX package information

- Capability management

- Adding capabilities
- Removing capabilities
- Getting capability information

- Driver management

- Adding drivers
- Removing drivers
- Removing drivers
- Exporting drivers to a folder
- Importing drivers from another image or installation
- Getting driver information
File renamed without changes.
File renamed without changes.
Loading

0 comments on commit 07de4fa

Please sign in to comment.